List all employers

GET

/employers

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

Query parameters

filterstringOptional

Multiple values can be provided by separating them with a comma. Allowed values are: pending, active, offboarding, inactive, restricted.

pageintegerOptional

page_sizeintegerOptional

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_pagebooleanOptional

Whether there are more pages available after this page

has_previous_pagebooleanOptional

Whether there are more pages available before this page

Built with

1	{
2	"items": [
3	{
4	"id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
5	"legal_name": "legal_name",
6	"legal_address": {
7	"line1": "line1",
8	"city": "city",
9	"postal_code": "postal_code",
10	"country_code": "af"
11	},
12	"contact": {
13	"name": "name",
14	"email": "email"
15	},
16	"platform_id": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
17	"status": "pending",
18	"registration_number": "registration_number",
19	"offboard_on": "2024-01-15T09:30:00Z",
20	"object": "object"
21	}
22	],
23	"page": 1,
24	"page_size": 1,
25	"total_count": 1,
26	"has_next_page": true,
27	"has_previous_page": true
28	}

1	curl https://test.api.kota.io/employers \
2	-H "Authorization: Bearer <apiKey>"