Skip to main content
GET
Get one employee

Authorizations

Authorization
string
header
required

Authorization: Bearer atk_live_…. Created in the API keys section of the Integrations settings; the secret is shown once.

Path Parameters

id
string
required

The employee id.

Query Parameters

company_id
string

One of the key's companies.

Response

OK

id
string
required

The employee id. Stable for the life of the record.

employeeNumber
string | null
required
firstName
string | null
required
preferredName
string | null
required
lastName
string | null
required
workEmail
string | null
required
workPhone
string | null
required
jobTitle
string | null
required
department
string | null
required
orgUnits
object[]
required

The structure levels below Company that the person sits in, outermost first.

location
string | null
required
companyId
string
required

The company that employs the person. Needs a key that holds this company.

managerId
string | null
required

The manager's employee id, from the position the person holds.

employmentType
string | null
required
status
enum<string>
required

upcoming: the hire is final and the start date is ahead. active: started and not yet left. left: the last day has passed or access has ended.

Available options:
upcoming,
active,
left
startDate
string | null
required

The first day of work, as a date in the company's time zone.

Pattern: ^\d{4}-\d{2}-\d{2}$
lastDay
string | null
required

The last day of work, as a date in the company's time zone. Null until a termination is recorded.

Pattern: ^\d{4}-\d{2}-\d{2}$
updatedAt
string<date-time>
required

When any field of this record last changed. Use it with updated_since.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
positionNumber
string | null
positionTitle
string | null
reportsToPositionId
string | null
personalEmail
string | null
mobile
string | null
homeAddress
object | null
dateOfBirth
string | null
Pattern: ^\d{4}-\d{2}-\d{2}$
nationality
string | null
gender
string | null
race
string | null
eeDesignation
string | null
disability
boolean | null
medicalAidMember
boolean | null