Custom Fields
v1
Get Custom Field Details
Fetch the details of a specific custom field using its internal name. The response returns the 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/{id}
Path parameters
idstring required
The custom field internal name.
Query parameters
account_idstring required
The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.
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": {
"request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
}
}