---
title: "List Organization Fields"
method: GET
path: "/api/v2/organization_fields"
tags: ["Organization Fields"]
---

# List Organization Fields

`GET /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](/api-reference/ticketing/organizations/organizations/) resource.

#### Pagination

* Cursor pagination (recommended)
* Offset pagination

See [Pagination](/api-reference/introduction/pagination/).

Returns a maximum of 100 records per page.

#### Allowed For

* Agents

## Query parameters

- `page[before]` string
- `page[after]` string
- `page[size]` integer

## Response `200`

Success response

- OrganizationFieldsResponse
  - `count` integer — Total count of records retrieved
  - `next_page` string, nullable — URL of the next page
  - `organization_fields` OrganizationFieldObject[]
    - `active` boolean — If true, this field is available for use
    - `created_at` string, date-time — The time of the last update of the ticket field
    - `custom_field_options` CustomFieldOptionObject[] — Required and presented for a custom field of type "dropdown". Each option is represented by an object with a `name` and `value` property
      - `id` integer — Automatically assigned upon creation
      - `name` string, required — Name of the dropdown option
      - `position` integer — Position of the dropdown option
      - `raw_name` string — Raw name of the dropdown option
      - `url` string — URL of the dropdown option
      - `value` string, required — Value of the dropdown option
    - `description` string — User-defined description of this field's purpose
    - `id` integer — Automatically assigned upon creation
    - `key` string, required — A unique key that identifies this custom field. This is used for updating the field and referencing in placeholders. The key must consist of only letters, numbers, and underscores. It can't be only numbers
    - `position` integer — Ordering of the field relative to other fields
    - `raw_description` string — The dynamic content placeholder, if present, or the `description` value, if not. See [Dynamic Content Items](/api-reference/ticketing/ticket-management/dynamic_content/)
    - `raw_title` string — The dynamic content placeholder, if present, or the `title` value, if not. See [Dynamic Content Items](/api-reference/ticketing/ticket-management/dynamic_content/)
    - `regexp_for_validation` string, nullable — Regular expression field only. The validation pattern for a field value to be deemed valid
    - `relationship_filter` object — A filter definition that allows your autocomplete to filter down results
    - `relationship_target_type` string — A representation of what type of object the field references. Options are "zen:user", "zen:organization", "zen:ticket", and "zen:custom_object:{key}" where key is a custom object key. For example "zen:custom_object:apartment".
    - `system` boolean — If true, only active and position values of this field can be changed
    - `tag` string — Optional for custom field of type "checkbox"; not presented otherwise.
    - `title` string, required — The title of the custom field
    - `type` string, required — The custom field type: "checkbox", "date", "decimal", "dropdown", "integer", ["lookup"](/api-reference/ticketing/lookup_relationships/lookup_relationships/), "multiselect", "regexp", "text", or "textarea"
    - `updated_at` string, date-time — The time of the last update of the ticket field
    - `url` string — The URL for this resource
  - `previous_page` string, nullable — URL of the previous page

---

[API](https://skmtc.net/botbrains-io/apis/support-api.md) · [All operations](https://skmtc.net/botbrains-io/apis/support-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/botbrains-io/support-api/versions/d53eac07ba68/schema)