List User Fields
GET {{baseUrl}}/api/v2/user_fields
Returns a list of custom user fields in your account. Fields are returned in the order that you specify in your user fields configuration in Zendesk Support. Clients should cache this resource for the duration of their API usage and map the key for each User Field to the values returned under the user_fields attribute on the User resource.
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Returns a maximum of 100 records per page.
Allowed For
- Agents
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"count":1,"next_page":null,"previous_page":null,"user_fields":[{"active":true,"created_at":"2012-10-16T16:04:06Z","description":"Description of Custom Field","id":7,"key":"custom_field_1","position":9999,"raw_description":"{{dc.my_description}}","raw_title":"Custom Field 1","regexp_for_validation":null,"title":"Custom Field 1","type":"text","updated_at":"2012-10-16T16:04:06Z","url":"https://company.zendesk.com/api/v2/user_fields/7.json"}]}