v1
latestOpenAPI 3.1.02026-07-14801408.6 KB/employees/:id
Returns all relevant information for a specific employee. Required scope: r_employees. Accessible with user access tokens and with account level tokens that provide member_id query param.
get/employees/{id}
Path parameters
subdomainstring required
The account subdomain
idstring required
The employee id
Query parameters
member_idstring
Optional member id for user tokens. Required for account tokens. Members endpoint GET /members
Response
200
Example response
{
"id": "2fbc",
"firstname": "Rex",
"lastname": "Abernathy",
"preferred_name": "Rex",
"employee_number": "5",
"status": "status_active",
"country": {
"display": "United Kingdom of Great Britain and Northern Ireland",
"value": "GB"
},
"address": {
"id": "EiVMb25kb24gUm9hZCwgSGlnaGZpZWxkLCBTaGVmZmllbGQsIFVLIi4qLAoUChIJIdmY0omCeUgRIY6G2ETqMl0SFAoSCaX6k4JignlIEeIrQ_I8jUrB",
"city": "Sheffield",
"bounds": {
"northeast": "53.36983958029149,-1.474926019708498",
"southwest": "53.36714161970849,-1.477623980291502"
},
"coords": "53.36849059999999, -1.476275",
"status": "PARTIAL_SUCCESS",
"country": "United Kingdom",
"zip_code": "S2",
"state_code": "England",
"subregion": "England",
"street_name": "London Road",
"country_code": "GB",
"location_string": "London Road, Highfield, Sheffield, UK"
},
"gender": "gender_male",
"birthdate": "1987-09-23T00:00:00.000Z",
"marital_status_group": {
"marital_status": "marital_status_married"
},
"phone_group": [
{
"row_id": "22b5e",
"is_primary": true,
"value": {
"phone_type": "phone_type_mobile",
"phone": "+18579909723"
}
}
],
"work_email": "rex_abernathy@sampleemployee.com",
"personal_email": [
{
"row_id": "2432e",
"is_primary": true,
"value": "rex_abernathy@gmail.com"
}
],
"chat_group": [
{
"row_id": "2431e",
"is_primary": true,
"value": {
"chat_type": "chat_type_slack",
"chat_username": "rex"
}
}
],
"social_group": [
{
"row_id": "24320",
"is_primary": true,
"value": {
"social_type": "social_type_facebook",
"social_url": "https://facebook.com/im/rex"
}
}
],
"job_title": "Account Manager ",
"hire_date": "2021-10-01T00:00:00.000Z",
"start_date": "2021-10-08T00:00:00.000Z",
"legal_entity": "e697173f-5853-48c0-8eb4-b9c67ca11a93",
"department": "3ff4d641",
"reports_to": "2fce",
"employment_group": [
{
"row_id": "22b5f",
"is_primary": true,
"value": {
"employment_effective_date": "2021-10-08T00:00:00.000Z",
"employment_status": "employement_type_full_time"
}
}
],
"work_schedule": "5c6",
"salary_group": [
{
"row_id": "22b60",
"is_primary": true,
"value": {
"salary_effective_date": "2021-10-08T00:00:00.000Z",
"salary_pay_type": "salary_pay_type_salary",
"salary_pay_rate": {
"amount": 90000,
"currency": "USD",
"frequency": "year"
},
"salary_pay_schedule": "salary_pay_schedule_every_15_days",
"salary_overtime_status": "salary_overtime_status_exempt",
"salary_justification": "salary_justification_new_hire"
}
}
],
"bank_details_group": {
"bank_details_bank_name": "Sterling",
"bank_details_iban": "STR123456789",
"bank_details_account_number": "234434"
},
"social_security_number_group": {
"social_security_number_number": "XI5542",
"social_security_number_issue_date": "1992-05-05T00:00:00.000Z"
},
"national_identification_number_group": {
"national_identification_number_number": "XI5542",
"national_identification_number_issue_date": "1992-05-05T00:00:00.000Z"
},
"social_insurance_number_group": [
{
"row_id": "24324",
"is_primary": true,
"value": {
"social_insurance_number_number": "XI5543",
"social_insurance_number_issue_date": "1992-05-05T00:00:00.000Z"
}
}
],
"tax_identification_number_group": {
"tax_identification_number_number": "IX444301",
"tax_identification_number_issue_date": "1992-05-05T00:00:00.000Z"
},
"nationality": {
"display": "United Kingdom of Great Britain and Northern Ireland",
"value": "GB"
},
"citizenship": [
{
"row_id": "24327",
"is_primary": true,
"value": {
"display": "United Kingdom of Great Britain and Northern Ireland",
"value": "GB"
}
}
],
"passport_group": [
{
"row_id": "24328",
"is_primary": true,
"value": {
"passport_country": {
"display": "United Kingdom of Great Britain and Northern Ireland",
"value": "GB"
},
"passport_number": "XIPAS12345",
"passport_issue_date": "2005-05-05T00:00:00.000Z",
"passport_expiration_date": "2024-05-05T00:00:00.000Z"
}
}
],
"education_group": [
{
"row_id": "24329",
"is_primary": true,
"value": {
"education_start_date": "2004-09-01T00:00:00.000Z",
"education_end_date": "2005-09-01T00:00:00.000Z",
"education_degree": "MSc",
"education_field_of_study": "Marketing",
"education_school": "UMIST"
}
}
],
"work_experience_group": [
{
"row_id": "2432a",
"is_primary": true,
"value": {
"work_experience_start_date": "2008-05-01T00:00:00.000Z",
"work_experience_end_date": "2019-05-01T00:00:00.000Z",
"work_experience_job_title": "Marketing Associate",
"work_experience_company": "Tesco"
}
}
],
"skills": [
{
"row_id": "2432b",
"is_primary": true,
"value": "MS Office"
}
],
"language": [
{
"row_id": "2432c",
"is_primary": true,
"value": "Hebrew"
}
],
"contact_group": [
{
"row_id": "2432d",
"is_primary": true,
"value": {
"contact_name": "Roxane Abernathy",
"contact_relationship": "contact_relationship_type_mother",
"contact_phone": "+1123456789",
"contact_email": "roxane@gmail.com",
"contact_country": {
"display": "United Kingdom of Great Britain and Northern Ireland",
"value": "GB"
}
}
}
],
"1195b": [
{
"row_id": "282b1",
"is_primary": true,
"value": {
"1195c": "7f63",
"1195d": "Custom contact field value"
}
}
]
}