List Custom Fields
GET/external/v1/custom-fieldsReturns 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
| Parameter | Type | Default | Description |
|---|---|---|---|
entity | string | - | Only the fields of one entity: contact, opportunity or company |
is_active | boolean | - | 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
| Field | Type | Description |
|---|---|---|
id | string | Definition identifier |
entity_type | string | contact, opportunity or company |
field_key | string | The key to use in custom_fields |
label | string | Name shown in the product |
field_type | string | text, memo, number, date, dropdown, multiselect, radio, checkbox, phone, email or url |
options | array | Accepted values for dropdown, multiselect and radio; empty for the other types |
is_required | boolean | Required in the product's forms |
placeholder / help_text | string | Form hints (nullable) |
position | integer | Order in the form |
is_active | boolean | Archived 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.