Associated Persons

Retrieve an associated person

Changed on

Retrieves an associated person object.

get/employees/{employee_id}/associated_persons/{associated_person_id}

Request

  • Base URL
    https://test.api.kota.io
  • URL
    https://test.api.kota.io/employees/{employee_id}/associated_persons/{associated_person_id}
  • Auth
    HTTP bearer

Path parameters

employee_idstring required
Example:ee_3b1333d87d9d4fd6ad83ba7f6b0e951a
associated_person_idstring required
Example:ap_3b1333d87d9d4fd6ad83ba7f6b0e951a

Response

OK

idstring required

Unique identifier for the associated person

platform_idstring

Unique identifier for the platform

employee_idstring required

Unique identifier for the employee this person is associated with

first_namestring required

First name of the associated person

last_namestring required

Last name of the associated person

date_of_birthstring date required

Date of birth of the associated person

sex_at_birth'male' | 'female' required
relationship_type'spouse' | 'partner' | 'child' | 'other' required
emailstring nullable

Email address of the associated person

phone_numberstring nullable

Phone number in E.164 international format (e.g. +447700900999)

objectstring

The object type

Example response

{
  "id": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "platform_id": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "date_of_birth": "2024-12-01"
}

Changes