Retrieve an employee

Retrieves an employee object.

Path parameters

employee_idstringRequiredformat: "ee_.+"

Response

first_namestring

last_namestring

date_of_birthstringformat: "date"

sex_at_birthenum

Allowed values:

national_tax_idstring

phone_numberstring

emailstring

platform_idstringOptionalformat: "pt_.+"

idstringOptionalformat: "ee_.+"

employer_idstringOptionalformat: "er_.+"

statusenumOptional

Allowed values:

external_customer_idstringOptional

A unique identifier assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This ID groups employees under this Customer, enabling the aggregation of contribution reporting and other values per Customer rather than per legal entity. This parameter is only available to EoR platforms.

home_addressobjectOptional

nationalityenumOptional

start_onstringOptionalformat: "date"

offboard_onstringOptionalformat: "date-time"

bank_accountobjectOptional

objectstringOptional

The object type

1	{
2	"first_name": "foo",
3	"last_name": "foo",
4	"date_of_birth": "2024-12-01",
5	"sex_at_birth": "male",
6	"national_tax_id": "foo",
7	"phone_number": "foo",
8	"email": "foo",
9	"platform_id": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
10	"id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
11	"employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
12	"status": "pending",
13	"external_customer_id": "foo",
14	"home_address": {
15	"line1": "foo",
16	"city": "foo",
17	"postal_code": "foo",
18	"country_code": "af",
19	"line2": "foo",
20	"line3": "foo",
21	"state": "foo"
22	},
23	"nationality": "af",
24	"start_on": "2024-12-01",
25	"offboard_on": "foo",
26	"bank_account": {
27	"account_number_last4": "foo"
28	},
29	"object": "foo"
30	}

Path parameters

Headers

Response

Errors

1	curl https://test.api.kota.io/employees/ee_3b1333d87d9d4fd6ad83ba7f6b0e951a \
2	-H "Authorization: Bearer <token>"