Skip to content

List Custom Fields ​

GET /external/v1/custom-fields

Returns the custom field definitions of your account. field_key is the key to use inside custom_fields when you create or update an opportunity or a contact; options lists the values accepted by dropdown, multiselect and radio fields.

Authentication ​

Requires custom_fields:read permission.

Query Parameters ​

ParameterTypeDefaultDescription
entitystring-Only the fields of one entity: contact, opportunity or company
is_activeboolean-true returns only active fields, false only archived ones

Request ​

bash
curl --request GET \
  --url "https://app.getraze.com/external/v1/custom-fields?entity=opportunity" \
  --header "X-API-Key: YOUR_API_KEY"
javascript
const axios = require('axios');

const response = await axios.get('https://app.getraze.com/external/v1/custom-fields', {
  headers: { 'X-API-Key': 'YOUR_API_KEY' },
  params: { entity: 'opportunity' }
});

console.log(response.data);
python
import requests

response = requests.get(
    'https://app.getraze.com/external/v1/custom-fields',
    headers={'X-API-Key': 'YOUR_API_KEY'},
    params={'entity': 'opportunity'}
)

print(response.json())

Response ​

json
{
  "success": true,
  "data": [
    {
      "id": "cf_01",
      "entity_type": "opportunity",
      "field_key": "lead_origin",
      "label": "Lead origin",
      "field_type": "dropdown",
      "options": ["Referral", "Event", "Website"],
      "is_required": false,
      "placeholder": null,
      "help_text": "Where the lead first heard about us",
      "position": 0,
      "is_active": true,
      "created_at": "2026-03-02T14:00:00Z",
      "updated_at": "2026-03-02T14:00:00Z"
    },
    {
      "id": "cf_02",
      "entity_type": "opportunity",
      "field_key": "annual_revenue",
      "label": "Annual revenue",
      "field_type": "number",
      "options": [],
      "is_required": false,
      "placeholder": null,
      "help_text": null,
      "position": 1,
      "is_active": true,
      "created_at": "2026-03-02T14:05:00Z",
      "updated_at": "2026-03-02T14:05:00Z"
    }
  ]
}

Response Fields ​

FieldTypeDescription
idstringDefinition identifier
entity_typestringcontact, opportunity or company
field_keystringThe key to use in custom_fields
labelstringName shown in the product
field_typestringtext, memo, number, date, dropdown, multiselect, radio, checkbox, phone, email or url
optionsarrayAccepted values for dropdown, multiselect and radio; empty for the other types
is_requiredbooleanRequired in the product's forms
placeholder / help_textstringForm hints (nullable)
positionintegerOrder in the form
is_activebooleanArchived fields keep their stored values but are no longer shown

Writing custom fields ​

json
{
  "custom_fields": {
    "lead_origin": "Event",
    "annual_revenue": 120000
  }
}

custom_fields merges into the existing values: keys you do not send are kept. Values are stored as sent and are not validated against the definition, so follow the field type.

GetRaze - AI-Powered Lead Generation