> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gomry.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Custom Fields

> List custom field definitions for your organization

# List Custom Fields

Returns the custom field definitions used to interpret the `custom_fields` map on contact responses.

**Required scope:** `custom_fields:read`

## Query Parameters

<ParamField query="page" type="integer" default="1" />

<ParamField query="page_size" type="integer" default="50">Maximum: `200`.</ParamField>
<ParamField query="record_type" type="string">Filter by record type. Currently only `contact`.</ParamField>

## Response

<ResponseField name="data" type="array">
  <Expandable title="Custom Field object">
    <ResponseField name="id" type="string" />

    <ResponseField name="name" type="string | null" />

    <ResponseField name="description" type="string | null" />

    <ResponseField name="type" type="string | null">e.g. `text`, `multipleChoice`, `date`, `number`, `dropdown`, `file`</ResponseField>
    <ResponseField name="record_type" type="string | null">Always `contact` today</ResponseField>

    <ResponseField name="required" type="boolean" />

    <ResponseField name="options" type="array">
      <Expandable title="Option">
        <ResponseField name="id" type="string" />

        <ResponseField name="label" type="string" />

        <ResponseField name="synonyms" type="string[]" />
      </Expandable>
    </ResponseField>

    <ResponseField name="status" type="string | null">`active` or `deleted`</ResponseField>

    <ResponseField name="created_at" type="string | null" />

    <ResponseField name="updated_at" type="string | null" />
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -H "X-API-KEY: your_api_key" "https://www.gomry.com/api/v1/custom-fields"
  ```
</RequestExample>