List Employees
GET {{baseUrl}}/hris/employees?raw=false&limit=1&filter[email]=elon@tesla.com&filter[first_name]=Elon&filter[last_name]=Musk&filter[title]=Manager&filter[manager_id]=1234&filter[employment_status]=active&filter[employee_number]=123456-AB&filter[department_id]=1234&sort[by]=created_at&sort[direction]=desc&pass_through[search]=San Francisco
Apideck operates as a stateless Unified API, which means that the list endpoint only provides a portion of the employee model. This is due to the fact that most HRIS systems do not readily provide all data in every call. However, you can access the complete employee model through an employee detail call.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
raw | boolean | Include raw response. Mostly used for debugging purposes | |
cursor | string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
limit | number | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
filter[company_id] | number | Apply filters | |
filter[email] | string | Apply filters | |
filter[first_name] | string | Apply filters | |
filter[last_name] | string | Apply filters | |
filter[title] | string | Apply filters | |
filter[manager_id] | number | Apply filters | |
filter[employment_status] | string | Apply filters | |
filter[employee_number] | string | Apply filters | |
filter[department_id] | number | Apply filters | |
sort[by] | string | Apply sorting | |
sort[direction] | string | Apply sorting | |
pass_through[search] | string | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | |
fields | string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: fields=name,email,addresses.city<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-apideck-consumer-id | string | (Required) ID of the consumer which you want to get or push data from | |
x-apideck-app-id | string | (Required) The ID of your Unify application | |
x-apideck-service-id | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | |
Accept | string |
RESPONSES
status: OK
{"status_code":200,"status":"OK","service":"sage-hr","resource":"Employees","operation":"all","data":[{"id":"12345","first_name":"Elon","last_name":"Musk","middle_name":"D.","display_name":"Technoking","preferred_name":"Elon Musk","initials":"EM","salutation":"Mr","title":"CEO","marital_status":"married","partner":{"id":"12345","first_name":"Elon","last_name":"Musk","middle_name":"D.","gender":"male","initials":"EM","birthday":"2000-08-12","deceased_on":"2000-08-12","custom_mappings":{}},"division":"Europe","division_id":"12345","department":"R\u0026D","department_id":"12345","department_name":"12345","team":{"id":"1234","name":"Full Stack Engineers"},"company_id":"23456","company_name":"SpaceX","employment_start_date":"2021-10-26","employment_end_date":"2028-10-26","leaving_reason":"resigned","employee_number":"123456-AB","employment_status":"active","employment_role":{"type":"other","sub_type":"not_specified"},"ethnicity":"African American","manager":{"id":"12345","name":"Elon Musk","first_name":"Elon","last_name":"Musk","email":"elon@musk.com","employment_status":"active"},"direct_reports":["a0d636c6-43b3-4bde-8c70-85b707d992f4","a98lfd96-43b3-4bde-8c70-85b707d992e6"],"social_security_number":"123456789","birthday":"2000-08-12","deceased_on":"2000-08-12","country_of_birth":"US","description":"A description","gender":"male","pronouns":"she,her","preferred_language":"EN","languages":["EN"],"nationalities":["US"],"photo_url":"https://unavatar.io/elon-musk","timezone":"Europe/London","source":"lever","source_id":"12345","record_url":"https://app.intercom.io/contacts/12345","jobs":[{"id":"12345","employee_id":"12345","title":"CEO","role":"Sales","start_date":"2020-08-12","end_date":"2020-08-12","compensation_rate":72000,"currency":"USD","payment_unit":"year","hired_at":"2020-08-12","is_primary":true,"is_manager":true,"status":"active","location":{"id":"123","type":"primary","string":"25 Spring Street, Blackburn, VIC 3130","name":"HQ US","line1":"Main street","line2":"apt #","line3":"Suite #","line4":"delivery instructions","street_number":"25","city":"San Francisco","state":"CA","postal_code":"94104","country":"US","latitude":"40.759211","longitude":"-73.984638","county":"Santa Clara","contact_name":"Elon Musk","salutation":"Mr","phone_number":"111-111-1111","fax":"122-111-1111","email":"elon@musk.com","website":"https://elonmusk.com","notes":"Address notes or delivery instructions.","row_version":"1-12345"}}],"compensations":[{"job_id":"3490439050957906679","rate":50,"payment_unit":"hour","flsa_status":"nonexempt","effective_date":"2021-06-11"}],"works_remote":true,"addresses":[{"id":"123","type":"primary","string":"25 Spring Street, Blackburn, VIC 3130","name":"HQ US","line1":"Main street","line2":"apt #","line3":"Suite #","line4":"delivery instructions","street_number":"25","city":"San Francisco","state":"CA","postal_code":"94104","country":"US","latitude":"40.759211","longitude":"-73.984638","county":"Santa Clara","contact_name":"Elon Musk","salutation":"Mr","phone_number":"111-111-1111","fax":"122-111-1111","email":"elon@musk.com","website":"https://elonmusk.com","notes":"Address notes or delivery instructions.","row_version":"1-12345"}],"phone_numbers":[{"number":"111-111-1111","id":"12345","country_code":"1","area_code":"323","extension":"105","type":"primary"}],"emails":[{"email":"elon@musk.com","id":"123","type":"primary"}],"custom_fields":[{"id":"2389328923893298","name":"employee_level","description":"Employee Level","value":"Uses Salesforce and Marketo"}],"social_links":[{"url":"https://www.twitter.com/apideck","id":"12345","type":"twitter"}],"bank_accounts":[{"bank_name":"Monzo","account_number":"123465","account_name":"SPACEX LLC","account_type":"credit_card","iban":"CH2989144532982975332","bic":"AUDSCHGGXXX","routing_number":"012345678","bsb_number":"062-001","branch_identifier":"001","bank_code":"BNH","currency":"USD"}],"tax_code":"1111","tax_id":"234-32-0000","dietary_preference":"Veggie","food_allergies":["No allergies"],"probation_period":{"start_date":"2021-10-01","end_date":"2021-11-28"},"tags":["New"],"custom_mappings":{},"row_version":"1-12345","deleted":true,"updated_by":"12345","created_by":"12345","updated_at":"2020-09-30T07:43:32.000Z","created_at":"2020-09-30T07:43:32.000Z"}],"meta":{"items_on_page":50,"cursors":{"previous":"em9oby1jcm06OnBhZ2U6OjE=","current":"em9oby1jcm06OnBhZ2U6OjI=","next":"em9oby1jcm06OnBhZ2U6OjM="}},"links":{"previous":"https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D","current":"https://unify.apideck.com/crm/companies","next":"https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}}