employees list
GET {{baseUrl}}/employees
Returns a list of Employee objects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
company_id | string | If provided, will only return employees for this company. | |
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
display_full_name | string | If provided, will only return employees with this display name. | |
employment_status | string | If provided, will only return employees with this employment status. | |
expand | string | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | |
first_name | string | If provided, will only return employees with this first name. | |
include_deleted_data | boolean | Whether to include data that was marked as deleted by third party webhooks. | |
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. | |
last_name | string | If provided, will only return employees with this last name. | |
manager_id | string | If provided, will only return employees for this manager. | |
modified_after | string | If provided, will only return objects modified after this datetime. | |
modified_before | string | If provided, will only return objects modified before this datetime. | |
page_size | number | Number of results to return per page. | |
pay_group_id | string | If provided, will only return employees for this pay group | |
personal_email | string | If provided, will only return Employees with this personal email | |
remote_fields | string | Which fields should be returned in non-normalized form. | |
remote_id | string | The API provider's ID for the given object. | |
team_id | string | If provided, will only return employees for this team. | |
work_email | string | If provided, will only return Employees with this work email | |
work_location_id | string | If provided, will only return employees for this location. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"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":"PREFER_NOT_TO_DISCLOSE","ethnicity":"BLACK_OR_AFRICAN_AMERICAN","marital_status":"SINGLE","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":"PENDING","termination_date":"2021-10-12T00:00:00Z","avatar":"http://alturl.com/h2h8m","remote_data":[{"path":"dolore magna reprehenderit id","data":{"et_7":{},"adipisicing2f9":{},"enim449":{}}},{"path":"irure","data":{"reprehenderitce5":{},"ipsum_b68":{},"dolord9":{},"et6a":{}}}],"custom_fields":{"aliquip348":{}},"remote_was_deleted":true},{"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":"OTHER","ethnicity":"AMERICAN_INDIAN_OR_ALASKA_NATIVE","marital_status":"SINGLE","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":"magna minim","data":{"reprehenderit21":{},"cupidatat_0":{}}},{"path":"reprehenderit Excepteur id aliqua","data":{"exercitation_29_":{}}}],"custom_fields":{"in_c4":{},"dolor3":{},"labore_5aa":{}},"remote_was_deleted":false}]}