employees retrieve
GET {{baseUrl}}/employees/:id
Returns an Employee
object with the given id
.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
expand | string | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. | |
include_sensitive_fields | boolean | Whether to include sensitive fields (such as social security numbers) in the response. | |
remote_fields | string | Which fields should be returned in non-normalized form. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"id":"0958cbc6-6040-430a-848e-aafacbadf4ae","remote_id":"19202938","employee_number":"2","company":"8d9fd929-436c-4fd4-a48b-0c61f68d6178","first_name":"Greg","last_name":"Hirsch","display_full_name":"Cousin Greg Hirsch","username":"cousingreg","groups":["21a54124-397f-494d-985e-3c5b330b8a68"],"work_email":"greg@merge.dev","personal_email":"greg@gmail.com","mobile_phone_number":"+1234567890","employments":["17a54124-287f-494d-965e-3c5b330c9a68"],"home_location":"d2f972d0-2526-434b-9409-4c3b468e08f0","work_location":"9efbc633-3387-4306-aa55-e2c635e6bb4f","manager":"0048ea5b-911e-4dff-9364-92070dea62ff","team":"249c9faa-3045-4a31-953b-8f22d3613301","pay_group":"ad1264e2-39be-4787-b749-f1aade9e3405","ssn":"1234567890","gender":"NON-BINARY","ethnicity":"AMERICAN_INDIAN_OR_ALASKA_NATIVE","marital_status":"HEAD_OF_HOUSEHOLD","date_of_birth":"1990-11-10T00:00:00Z","hire_date":"2020-10-10T00:00:00Z","start_date":"2020-10-11T00:00:00Z","remote_created_at":"2020-10-11T00:00:00Z","employment_status":"INACTIVE","termination_date":"2021-10-12T00:00:00Z","avatar":"http://alturl.com/h2h8m","remote_data":[{"path":"est Lorem quis","data":{"culpa_0":{},"cupidatat4c":{}}},{"path":"incididunt do","data":{"dolore_545":{},"proident8a9":{}}}],"custom_fields":{"velit_d":{}},"remote_was_deleted":true}