Get an employee's custom fields
GET {{baseUrl}}/v1/employees/:employee_id/custom_fields?page=<number>&per=<number>
Returns a list of the employee's custom fields.
scope: employees:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
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 |
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
{"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"]}]}