API reference

Get one employee

GET
/v1/employees/{id}

Authorization

headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Enter the client ID and client secret from Settings, API access; the token lasts one hour.

Path Parameters

id*string
Formatuuid

Response Body

The employee.

application/json
  1. response
data*

Deliberately small: what identifies a person, their job title and department, status, start and leaving dates, and the holiday calendar they follow. Email, line manager, team, location, employment type, probation date and contracted hours are not part of v1.

curl -X GET "https://example.com/v1/employees/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "first_name": "string",    "last_name": "string",    "preferred_name": "string",    "job_title": "string",    "department": "string",    "status": "string",    "start_date": "2019-08-24",    "leaving_date": "2019-08-24",    "holiday_calendar": "string",    "updated_at": "2019-08-24T14:15:22Z"  }}