Get an employee
GET {{baseUrl}}/v1/employees/:employee_id?include=<string>
Get an employee.
scope: employees:read
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
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 |
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. | |
Accept | string |
RESPONSES
status: OK
{"uuid":"4b3f930f-82cd-48a8-b797-798686e12e5e","first_name":"Isom","middle_initial":null,"last_name":"Jaskolski","email":"dane7757869450111550@botsford.net","company_uuid":"a007e1ab-3595-43c2-ab4b-af7a5af2e365","manager_uuid":"5e53e257-c8d6-45aa-aa8a-ec99283a3acd","version":"1c7ba9d62c8bafbfff998ffccad5d296","department":"Stage Hand","department_uuid":"56260b3d-c375-415c-b77a-75d99f717193","terminated":false,"two_percent_shareholder":false,"onboarded":true,"onboarding_status":"onboarding_completed","jobs":[{"uuid":"428a653a-0745-4db4-9c80-558288d416fa","version":"6c0ed1521e8b86eb36bd4455a63a2dac","employee_uuid":"f0689739-1985-49f3-b9ba-84562e71e85f","current_compensation_uuid":"c9fd719b-8b07-48f3-8a4c-f447d2c59669","payment_unit":"Year","primary":true,"title":"Client Support Director","compensations":[{"uuid":"145660ed-6fcc-4211-8915-18e2786290a2","version":"2cd4b18662395eb53bcf80d5b5447f36","payment_unit":"Year","flsa_status":"Exempt","job_uuid":"857feae3-414e-445d-b28b-2eb3ef50155e","effective_date":"2021-01-20","rate":"70000.00","adjust_for_minimum_wage":false,"minimum_wages":[]}],"rate":"70000.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":"31.8","maximum_accrual_balance":"240.0","paid_at_termination":false},{"name":"Vacation Hours","policy_name":"Vacation Policy","policy_uuid":"ab59de61-239f-4805-933b-0e3360ed291c","accrual_unit":"Hour","accrual_rate":"208.0","accrual_period":"Year","accrual_balance":"77.8","maximum_accrual_balance":"240.0","paid_at_termination":true}],"terminations":[],"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"]}],"garnishments":[],"date_of_birth":"1986-06-25","has_ssn":false,"ssn":"","phone":"1234567890","preferred_first_name":"Angel","work_email":"angel.jaskolski@example.com"}