Sign in
User Fields

List 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
get/api/v2/user_fields

Response

Success response

countinteger

Total count of records retrieved

next_pagestring nullable

URL of the next page

previous_pagestring nullable

URL of the previous page

Changes