Custom Fields
v1
Retrieve Custom Fields
Retrieve the list of all custom field definitions available in the account. The response includes each field's attributes.
Credit Note: Retrieving custom field definitions does not consume credits.
:::info Requires the custom_fields:read OAuth2 scope. :::
get/v1/custom-fields
Query parameters
account_idstring required
The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.
page[num]integer
Page of results to fetch.
page[size]integer
The number of items per page. Maximum is 100.
filter[scope]'company' | 'contact'
Filter by entities that apply to either company or contact. If omitted, returns both kinds of entities.
filter[type]'text' | 'number' | 'boolean' | 'date' | 'contact_collection' | 'ai_score' | 'ai_text' | 'ai_number' | 'ai_boolean'
Filter by field type. If omitted, returns all field types.
Response
Success
Example response
{
"data": [
{
"type": "custom_field",
"id": "score",
"attributes": {
"name": "Prospect",
"scope": "company",
"type": "text",
"source": "user",
"created_at": "2024-12-10T15:57:25Z",
"updated_at": "2024-11-24T11:50:00Z",
"configuration": {
"prompt_category": "technologies"
}
},
"relationships": {
"created_by": {
"id": "12345"
}
}
}
],
"meta": {
"pagination": {
"page_num": 1,
"page_count": 1,
"total_count": 1
},
"request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
}
}