Deal custom field labels

List deal custom field labels

Filtered request example — Dropdown custom fields in one group:

curl -g -H "Authorization: Bearer pcrm_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  "https://api.pipelinecrm.com/api/v3/admin/deal_custom_field_labels.json?conditions[custom_field_label_field_type]=dropdown&conditions[custom_field_label_custom_field_group]=7"
get/admin/deal_custom_field_labels

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/admin/deal_custom_field_labels
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header app-key
    • API key in query parameter api_key and API key in query parameter app_key

Query parameters

custom_field_label_namestring

Returns records that match a LIKE query on the name field

custom_field_label_field_typestring

Returns records with the given field_type

custom_field_label_custom_field_groupinteger

Returns records for the given custom_field_group_id

Filters as bracketed query parameters, for example ?conditions[custom_field_label_field_type]=dropdown. Each key below is one filter; see the Filtering guide for the value formats (ids, lists, date ranges, number ranges, custom fields) and the example above for a complete request.

{
  "custom_field_label_name": "Industry",
  "custom_field_label_field_type": "dropdown",
  "custom_field_label_custom_field_group": 1
}

Response

Successful Response

Example response

{
  "pagination": {
    "page": 1,
    "per_page": 200,
    "total": 670,
    "pages": 4,
    "total_in_account": 1204,
    "page_var": "page",
    "url": "/api/v3/deals.json"
  },
  "entries": [
    {
      "id": 4821,
      "created_at": "2026-09-01 14:22:07",
      "updated_at": "2026-09-01 14:22:07",
      "field_type": "dropdown",
      "name": "Contract term",
      "record_type": "deal"
    }
  ]
}

Changes

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