Retrieve an employer

GET

/employers/:employer_id

GET

/employers/:employer_id

$ curl https://test.api.kota.io/employers/er_3b1333d87d9d4fd6ad83ba7f6b0e951a \
>      -H "Authorization: Bearer <token>"

1 {
2   "id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3   "legal_name": "Acme Corporation Ltd",
4   "legal_address": {
5     "line1": "123 Main Street",
6     "city": "Springfield",
7     "postal_code": "62704",
8     "country_code": "us",
9     "line2": null,
10     "line3": null,
11     "state": "IL"
12   },
13   "contact": {
14     "name": "Jane Doe",
15     "email": "jane.doe@acmecorp.com"
16   },
17   "platform_id": "pt_7f9a2c4d5e6b7a8c9d0e1f2a3b4c5d6e",
18   "status": "active",
19   "registration_number": "12345678",
20   "offboard_on": "2024-12-01T00:00:00Z",
21   "earliest_benefits_start_date": "2024-12-01",
22   "metadata": {
23     "industry": "Manufacturing",
24     "employee_count": "250"
25   },
26   "object": "employer"
27 }

Retrieves an employer object.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

employer_idstringRequiredformat: "er_.+"

Response

idstringformat: "er_.+"

legal_namestring

legal_addressobject

contactobject

platform_idstringOptionalformat: "pt_.+"

statusenumOptional

registration_numberstring or nullOptional

offboard_ondatetime or nullOptional

earliest_benefits_start_datedate or nullOptional

metadatamap from strings to strings or nullOptional

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.

objectstringOptionalRead-only

The object type

Errors

404

Not Found Error