Skip to content

List Custom Field Definitions

GET https://api.copper.com/developer_api/v1/custom_field_definitions

Custom Field Definitions specify account specific fields not included as part of the standard resource fields and allows Copper to be customized to your specific workflow. The Custom Field Definitions API allows you to retrieve the list of Custom Field Definitions associated with your Copper account.

Field Type Details
id identifier Unique identifier for the custom field definition.
name string Label for the custom field definition
data_type string The type of data that should be stored within this custom field. Possible values are: String, Text, Dropdown, Date, Checkbox, Float, URL, Percentage, Currency, Connect and MultiSelect
available_on string[] List of strings containing one or more of the following: “lead”, “person”, “opportunity”, “company”, "project", "task"
is_filterable boolean Indicates if the Custom Field Definition can be included in filters.
currency string The currency used for this custom field definition. Valid only when the data type is Currency.
options object[] A list of possible dropdown options. Valid only when the data type is Dropdown.

Example Requests

Custom Field Definitions

curl --request GET "https://api.copper.com/developer_api/v1/custom_field_definitions" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json"

[
  {
    "id": 100764,
    "name": "A Text Field",
    "data_type": "String",
    "available_on": [
      "company",
      "opportunity",
      "lead",
      "person"
    ],
    "is_filterable": true
  },
  {
    "id": 103481,
    "name": "A Text Area Field",
    "data_type": "Text",
    "available_on": [
      "lead",
      "company",
      "opportunity",
      "person"
    ],
    "is_filterable": false
  },
  {
    "id": 126240,
    "name": "Color option",
    "data_type": "Dropdown",
    "available_on": [
      "opportunity",
      "project"
    ],
    "is_filterable": false,
    "options": [
      {
        "id": 167776,
        "name": "Yellow",
        "rank": 4
      },
      {
        "id": 167775,
        "name": "Orange",
        "rank": 3
      },
      {
        "id": 167774,
        "name": "Blue",
        "rank": 2
      },
      {
        "id": 167773,
        "name": "Green",
        "rank": 1
      },
      {
        "id": 167772,
        "name": "Red",
        "rank": 0
      }
    ]
  }
]