List all contribution reports | Kota Developer Products Documentation

Returns a list of contribution reports. The reports are returned sorted by creation date, with the most recent reports appearing first.

Query parameters

employer_idstringOptionalformat: "er_.+"

Unique identifier of the employer for filtering reports

statusenumOptional

Filter reports by status: open or finalized

Allowed values:

monthintegerOptional

Month for filtering reports, used together with year (MM format)

yearintegerOptional

Year for filtering reports, can be used standalone or with month (YYYY format)

external_customer_idstringOptional

Unique identifier of the customer for EoR platforms, used to filter reports for a logical employer

pageintegerOptional

The page of results to return. Defaults to 1 if not provided.

page_sizeintegerOptional

The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.

Response

itemslist of objects

A paginated array containing the response elements

pageinteger

The current page of the results

page_sizeinteger

The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size

total_countinteger

The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.

has_next_pageboolean or nullRead-only

Whether there are more pages available after this page

has_previous_pageboolean or nullRead-only

Whether there are more pages available before this page

1	{
2	"items": [
3	{
4	"id": "ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
5	"employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
6	"period": {
7	"from_date": "2024-12-01",
8	"to_date": "2024-12-01"
9	},
10	"status": "open",
11	"created_at": "2024-12-01T00:00:00Z",
12	"last_updated_at": "2024-12-01T00:00:00Z",
13	"object": "string",
14	"external_customer_id": null,
15	"finalized_at": "2024-12-01T00:00:00Z"
16	}
17	],
18	"page": 123,
19	"page_size": 123,
20	"total_count": 123,
21	"has_next_page": true,
22	"has_previous_page": true
23	}