API reference List custom fields List custom fields Returns the custom fields defined on your team's people, paginated. Includes the fields you created with the API and the ones synced from your CRM…
GET /v2/api/crm/attributes
Returns the custom fields defined on your team's people, oldest first. The list includes the fields you created with the API and the ones synced from your CRM integrations. Deleted (archived) fields and built-in fields such as name or company are not listed.
Query parameters
Parameter Type Default Description pageinteger 1Page number, starting at 1 sizeinteger 20Items per page, from 1 to 100
See Pagination .
Response fields
Field Type Description keystring Unique key of the field labelstring or null Display name typestring or null TEXT, NUMBER, DATE, BOOLEAN or DROPDOWNoptionsarray { key, label } objects. Only present for DROPDOWNsourcestring allo, or the integration that manages the field, such as hubspot
Copy {
"data" : [
{ "key" : "budget" , "label" : "Budget" , "type" : "NUMBER" , "source" : "allo" } ,
{
"key" : "lead_status" ,
"label" : "Lead status" ,
"type" : "DROPDOWN" ,
"options" : [
{ "key" : "hot" , "label" : "Hot" } ,
{ "key" : "cold" , "label" : "Cold" }
] ,
"source" : "allo"
}
] ,
"pagination" : {
"page" : 1 ,
"size" : 20 ,
"total_count" : 2 ,
"total_pages" : 1 ,
"has_more" : false
}
}
Errors
Status Code When 400INVALID_PAGE_SIZEpage is below 1 or size is not between 1 and 100403API_KEY_INSUFFICIENT_SCOPEThe key does not hold CRM_READ 404TEAM_NOT_FOUNDThe workspace is not on the new contact model
Authorization Authorizationstring · header required
Api-Key ak_live_…
Query parameters pageinteger
Page number (1-indexed)
sizeinteger
Results per page
Responses 200 List of custom contact fields dataobject[]
5 fields keystring
Unique key of the field within your team
labelstring | null
Display name of the field
typeenum<string>
Value type
TEXTNUMBERDATEBOOLEANDROPDOWN
optionsobject[]
Allowed values. Only set for DROPDOWN fields.
2 fields sourcestring
allo for fields created in Allo or with the API, otherwise the lowercase name of the integration that manages it, such as hubspot
400 401 403 404 429