---
title: "List Custom Object Fields"
method: GET
path: "/api/v2/custom_objects/{custom_object_key}/fields"
tags: ["Custom Object Fields"]
---

# List Custom Object Fields

`GET /api/v2/custom_objects/{custom_object_key}/fields`

Lists all undeleted custom fields for the specified object.

#### Allowed For
* Agents

#### Pagination
* Cursor pagination (recommended)
* Offset pagination

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

## Path parameters

- `custom_object_key` string, required

## Query parameters

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

## Response `200`

Success response

- CustomObjectFieldsResponse
  - `custom_object_fields` CustomObjectField[]
    - `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

## Changes

> 29 revisions in range; 1 not diffed, 1 could not be searched.

- **2025-06-12** `edbf399da815` — 3 info
  - added the new optional `query` request parameter `page[after]`
  - added the new optional `query` request parameter `page[before]`
  - added the new optional `query` request parameter `page[size]`

[Change history](https://skmtc.dev/botbrains-io/apis/support-api/changes/api/v2/custom_objects/:custom_object_key/fields/get.md)

---

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