For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get access
Getting Started Key Concepts Integration Types Core Components Embed Hosted API API Reference
  • API Reference
      • GETList all employers
      • POSTCreate an employer
      • GETRetrieve an employer
      • PUTUpdate an employer
      • POSTOffboard an employer
    • Contribution Reports
    • Events and Webhooks
    • API Errors
Get access
LogoLogo
API ReferenceEmployers

List all employers

GET
/employers
GET
/employers
$curl https://test.api.kota.io/employers \
>     -H "Authorization: Bearer <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "items": [
3    {
4      "id": "er_9f8b7c6d5a4e3f2b1c0d9e8f7a6b5c4d",
5      "legal_name": "Acme Corporation Ltd",
6      "legal_address": {
7        "line1": "123 Main Street",
8        "city": "San Francisco",
9        "postal_code": "94105",
10        "country_code": "us",
11        "line2": "Suite 400",
12        "state": "CA"
13      },
14      "contact": {
15        "name": "Jane Doe",
16        "email": "jane.doe@acmecorp.com"
17      },
18      "platform_id": "pt_1a2b3c4d5e6f7g8h9i0jklmnopqrstuv",
19      "status": "active",
20      "registration_number": "98765432",
21      "offboard_on": "2024-12-01T00:00:00Z",
22      "earliest_benefits_start_date": "2024-12-01",
23      "metadata": {
24        "industry": "Technology",
25        "employee_count": "250"
26      },
27      "object": "employer"
28    }
29  ],
30  "page": 1,
31  "page_size": 10,
32  "total_count": 25,
33  "has_next_page": true,
34  "has_previous_page": false
35}

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

Previous

API Introduction

Next

Create an employer

Built with

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Query parameters

filterstringOptional

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

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

OK
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_pagebooleanRead-only
Whether there are more pages available after this page
has_previous_pagebooleanRead-only
Whether there are more pages available before this page

Errors

400
Bad Request Error
404
Not Found Error