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

# List custom field definitions

`GET /custom_field_definitions`

## Request

- Base URL: `https://api.copper.com/developer_api/v1`
- URL: `https://api.copper.com/developer_api/v1/custom_field_definitions`
- Auth: HTTP bearer

Retrieve a list of all custom field definitions in the account

## Response `200`

Custom field definitions retrieved successfully

- CustomFieldDefinition[]
  - `id` integer, required: Unique identifier for the custom field definition
  - `name` string, required: Name of the custom field
  - `canonical_name` string, nullable: Canonical name for the custom field
  - `data_type` 'String' | 'Text' | 'Dropdown' | 'MultiSelect' | 'Date' | 'Checkbox' | 'Float' | 'URL' | 'Percentage' | 'Currency' | 'Connect', required: Data type of the custom field
  - `available_on` string[], required: Array of entity types this field is available on
  - `options` object[]: Available options for Dropdown and MultiSelect field types
    - `id` integer: The option ID
    - `name` string: The option name/value
    - `rank` integer: The display order of the option
  - `currency` string, nullable: Currency code for Currency field types

## Other responses

- `400`: Bad Request - The request was invalid or cannot be served
- `401`: Unauthorized - Authentication credentials were missing or incorrect
- `429`: Too Many Requests - Rate limit exceeded
- `500`: Internal Server Error - An unexpected error occurred

---

[API](https://skmtc.dev/copper/apis/copper-crm-read-only-api.md) - [All operations](https://skmtc.dev/copper/apis/copper-crm-read-only-api/llms.txt) - [OpenAPI document](https://skmtc.dev/copper/apis/copper-crm-read-only-api/revisions/96adc8557a40?raw)