Get employees of a company
GET {{baseUrl}}/v1/companies/:company_id/employees?terminated=<boolean>&include=<string>&page=<number>&per=<number>&search_term=<string>
Get all of the employees, onboarding, active and terminated, for a given company.
scope: employees:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
terminated | string | Filters employees by the provided boolean | |
include | string | Include the requested attribute(s) in each employee response, multiple options are comma separated. Available options: |
- all_compensations: Include all effective dated compensations for each job instead of only the current compensation
- custom_fields: Include employees' custom fields |
|
page| string | | The page that is requested. When unspecified, will load all objects unless endpoint forces pagination. | |per| string | | Number of objects per page. For majority of endpoints will default to 25 | |search_term| string | | A string to search for in the object's names |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
[{"uuid":"9779767c-6044-48e0-bf68-aeb370b9a2e7","first_name":"Nicole","middle_initial":"M","last_name":"Boehm","email":"kory7757869450111548@barton-hermiston.io","company_uuid":"c44d66dc-c41b-4a60-9e25-5e93ff8583f2","manager_uuid":"5e53e257-c8d6-45aa-aa8a-ec99283a3acd","version":"414dedaca594b77135e0b8d2f398516d","department":"Stage Hand","department_uuid":"1802465d-4f68-4865-920c-1307ab095f12","terminated":false,"two_percent_shareholder":false,"onboarded":true,"onboarding_status":"onboarding_completed","jobs":[{"uuid":"5d5e3ce5-ea8f-4885-90e5-7ebaed03f7c5","version":"91179081a7309c9fbd31bb3cf7b9893e","employee_uuid":"a987bce1-6d06-43f8-9978-9db886f479fb","current_compensation_uuid":"798a962f-0fcf-491e-9b71-cfa6a1db114f","payment_unit":"Hour","primary":true,"title":"Client Support Manager","compensations":[{"uuid":"94f17a77-cfe5-436a-af94-422bbf8248ff","version":"233f0096a8015e62d9795fadf1fd300d","payment_unit":"Hour","flsa_status":"Nonexempt","job_uuid":"64711ac0-83ff-4aaf-bec1-db72f5a44e56","effective_date":"2021-01-20","rate":"22.00","adjust_for_minimum_wage":false,"minimum_wages":[]}],"rate":"22.00","hire_date":"2020-01-20"}],"eligible_paid_time_off":[{"name":"Sick Hours","policy_name":"Sick Policy","policy_uuid":"9940d205-9904-4e55-9fec-652628e84af7","accrual_unit":"Hour","accrual_rate":"208.0","accrual_method":"per_hour_worked","accrual_period":"Year","accrual_balance":"71.0","maximum_accrual_balance":"240.0","paid_at_termination":false},{"name":"Vacation Hours","policy_name":"Vacation Policy","policy_uuid":"8b312f0e-30e7-4810-9c06-1177a6484f2d","accrual_unit":"Hour","accrual_rate":"208.0","accrual_period":"Year","accrual_balance":"34.0","maximum_accrual_balance":"240.0","paid_at_termination":true}],"terminations":[],"garnishments":[],"date_of_birth":"1996-05-08","has_ssn":true,"ssn":"","phone":"1234567890","preferred_first_name":"Vanessa","work_email":"vanessa.boehm@example.com"},{"uuid":"d7cb289a-af62-4120-9cd5-acda324b5c04","first_name":"Maci","middle_initial":"M","last_name":"Cassin","email":"claud_reinger7757869450111549@gutkowski.net","company_uuid":"4522d043-5731-406d-a129-de1808042a32","manager_uuid":"5e53e257-c8d6-45aa-aa8a-ec99283a3acd","version":"e867459e1360fa71e78b88142923d341","department":"Band","department_uuid":"1802465d-4f68-4865-920c-1307ab095f12","terminated":false,"two_percent_shareholder":false,"onboarded":true,"onboarding_status":"onboarding_completed","jobs":[{"uuid":"62a00cf7-342b-465e-a151-ecd295152be0","version":"d0e719137f89ca3dd334dd4cc248ffbb","employee_uuid":"5e53e257-c8d6-45aa-aa8a-ec99283a3acd","current_compensation_uuid":"93e5da92-173b-4faa-a0bd-d1a8dee68be0","payment_unit":"Year","primary":true,"title":"Account Director","compensations":[{"uuid":"1bad5177-c4ed-432e-ab43-66055d40c3a5","version":"994b75511d1debac5d7e2ddeae13679f","payment_unit":"Year","flsa_status":"Exempt","job_uuid":"1214875b-f43d-4267-bf2f-a6d2c298ff3d","effective_date":"2021-01-20","rate":"78000.00","adjust_for_minimum_wage":false,"minimum_wages":[]}],"rate":"78000.00","hire_date":"2020-01-20"}],"eligible_paid_time_off":[{"name":"Sick Hours","policy_name":"Sick Policy","policy_uuid":"8b312f0e-30e7-4810-9c06-1177a6484f2d","accrual_unit":"Hour","accrual_rate":"208.0","accrual_method":"per_hour_worked","accrual_period":"Year","accrual_balance":"74.0","maximum_accrual_balance":"240.0","paid_at_termination":false},{"name":"Vacation Hours","policy_name":"Vacation Policy","policy_uuid":"0d4c755e-50ac-4c54-b46e-81bdfa03da5b","accrual_unit":"Hour","accrual_rate":"208.0","accrual_period":"Year","accrual_balance":"16.0","maximum_accrual_balance":"240.0","paid_at_termination":true}],"terminations":[],"garnishments":[],"custom_fields":[{"id":"ee515986-f3ca-49da-b576-2691b95262f9","company_custom_field_id":"ea7e5d57-6abb-47d7-b654-347c142886c0","name":"employee_level","description":"Employee Level","type":"text","value":"2","selection_options":null},{"id":"3796e08d-c2e3-434c-b4de-4ce1893e7b59","company_custom_field_id":"299650e4-e970-4acf-9bf0-6f05585d20ba","name":"t-shirt size","description":"What is your t-shirt size?","type":"text","value":"md","selection_options":null},{"id":"3796e08d-c2e3-434c-b4de-4ce1893e7b59","company_custom_field_id":"024ec137-6c92-43a3-b061-14a9720531d6","name":"favorite fruit","description":"Which is your favorite fruit?","type":"radio","value":"apple","selection_options":["apple","banana","orange"]}],"date_of_birth":"1995-09-21","has_ssn":true,"ssn":"","phone":"1234567890","preferred_first_name":"Denis","work_email":"denis.cassin@example.com"}]