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

Retrieve an employer

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": "string",
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": "string",
20  "offboard_on": "2024-01-15T09:30:00Z",
21  "earliest_benefits_start_date": "2024-12-01",
22  "object": "string"
23}
Retrieves an `employer` object.

Path parameters

employer_idstringRequiredformat: "er_.+"

Headers

AuthorizationstringRequired
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

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"
objectstring or null
The object type

Errors

Was this page helpful?
Previous

Update an employer

Next
Built with
OK

Bearer authentication of the form Bearer <token>, where token is your auth token.

Retrieves an employer object.