---
title: "List custom field definitions"
method: GET
path: "/v1/custom_field_definitions"
tags: ["Custom Field Definitions"]
---

# List custom field definitions

`GET /v1/custom_field_definitions`

## Request

- Base URL: `https://api.capacity.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.capacity.com/v1/custom_field_definitions`
- Auth: one of:
  - API key in header `x-capacity-id`
  - HTTP bearer

Returns a paginated list of custom field definitions with optional filtering by name.

## Query parameters

- `page` integer
- `limit` integer
- `name_like` string

## Response `200`

List of custom field definitions

- object
  - `body` object: Json body data in the request
  - `limit` integer: Number of results returned
  - `page` integer: Page of results returned
  - `parameters` object: Query parameters in the request
  - `result` CustomFieldDefinitionReadSchema[]
    - `custom_field_name` string: Formatted name of the custom field
    - `custom_field_uuid` string: Formatted UUID of the custom field
    - `custom_field_values` string[]: List of possible values for the custom field
    - `custom_field_type` string: Display name of the custom field type
    - `is_dependent` boolean: Whether this field depends on another custom field
    - `parent_custom_field` object, nullable: Information about the parent custom field (present if dependent)
      - `id` string
      - `name` string
      - `uuid` string
    - `resources` object[]: Grouped resource types to which the field applies
      - `name` string
      - `resource_parent_id` integer
      - `resource_child_ids` integer[]
      - `is_required` boolean

## Other responses

- `500`: Internal server error

---

[API](https://skmtc.dev/capacity/apis/capacity-api-docs.md) - [All operations](https://skmtc.dev/capacity/apis/capacity-api-docs/llms.txt) - [OpenAPI document](https://skmtc.dev/capacity/apis/capacity-api-docs/revisions/74c85bb61004?raw)