Get access
DocumentationAPI ReferenceEmbed SDK Reference
  • API Reference
    • Contribution Reports
    • Events and Webhooks
    • API errors
Get access
LogoLogo
LogoLogo
API ReferenceEmployers

GET
/employers/:employer_id
GET
/employers/:employer_id
1curl https://test.api.kota.io/employers/er_3b1333d87d9d4fd6ad83ba7f6b0e951a \
2     -H "Authorization: Bearer <token>"
Try it
200Retrieved
1{
2  "id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3  "legal_name": "Acme Corporation Ltd",
4  "legal_address": {
5    "line1": "string",
6    "city": "string",
7    "postal_code": "string",
8    "country_code": "af",
9    "line2": "string",
10    "line3": "string",
11    "state": "string"
12  },
13  "contact": {
14    "name": "string",
15    "email": "string"
16  },
17  "platform_id": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
18  "status": "pending",
19  "registration_number": "12345678",
20  "offboard_on": "2024-12-01T00:00:00Z",
21  "earliest_benefits_start_date": "2024-12-01",
22  "metadata": {},
23  "object": "string"
24}
Was this page helpful?
Previous

Update an employer

Next
Built with
Retrieves an `employer` object.
Retrieve an employer

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path Parameters

employer_idstringRequiredformat: "er_.+"

Response

OK
idstringformat: "er_.+"
legal_namestring
legal_addressobject
contactobject
platform_idstring or nullformat: "pt_.+"
statusenum or null
Allowed values:
registration_numberstring or null
offboard_onstring or nullformat: "date-time"
earliest_benefits_start_datestring or nullformat: "date"
metadatamap from strings to strings or null
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters.
objectstring or null
The object type

Errors

Retrieves an employer object.

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters.