COcopper
Custom Fields

List custom field definitions

Retrieve a list of all custom field definitions in the account

get/custom_field_definitions

Request

  • Base URL
    https://api.copper.com/developer_api/v1
  • Auth
    HTTP bearer

Response

Custom field definitions retrieved successfully

idinteger required

Unique identifier for the custom field definition

namestring required

Name of the custom field

canonical_namestring 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_onstring[] required

Array of entity types this field is available on

currencystring nullable

Currency code for Currency field types

Example response

[
  {
    "id": 100764,
    "name": "Multi-Select Dropdown",
    "data_type": "MultiSelect",
    "available_on": [
      "lead",
      "person",
      "opportunity",
      "company"
    ],
    "currency": "USD"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.