List Organization Fields

GET {{baseUrl}}/api/v2/organization_fields

Returns a list of custom organization fields in your account. Fields are returned in the order that you specify in your organization fields configuration in Zendesk Support. Clients should cache this resource for the duration of their API usage and map the key for each organization field to the values returned under the organization_fields attribute on the organization resource.

Pagination

  • Cursor pagination (recommended)
  • Offset pagination

See Pagination.

Returns a maximum of 100 records per page.

Allowed For

  • Agents

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"count":1,"next_page":null,"organization_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/organization_fields/7.json"}],"previous_page":null}