List Contact Custom Fields
Returns a list of all contact custom fields defined in your account. Custom field IDs returned here are used to set or retrieve custom field values on contacts via the Contact List Contact endpoints.
Endpoint
GET
v5/contactcustomfield
Requires authentication
Path Parameters
This endpoint does not include path parameters.
None
Query Parameters
All query parameters are optional.
page
integer
Page number to return. Defaults to 1.
resultsperpage
integer
Number of results to return per page. Default is 50, maximum is 500.
Response
Returns a keyed object of contact custom field objects, where each key is the field ID.
result_ok
boolean
Whether the request succeeded.
data
object
Keyed object of custom field objects, where each key is the field's numeric ID string.
child attributes
id
string
The unique numeric ID of the custom field.
name
string
The name of the custom field.
type
string
The data type of the custom field. Values:
Text, Date/Time, Currency, Number, Yes/No.Examples
Note GET requests are cached for 60 seconds. Repeated identical requests within that window will return cached results.
Request (cURL)
curl -X GET "https://api.alchemer.com/v5/contactcustomfield?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET"
Response
{
"result_ok": true,
"data": {
"1": {
"id": "1",
"name": "customer_id",
"type": "Number"
},
"2": {
"id": "2",
"name": "subscription_type",
"type": "Text"
},
"3": {
"id": "3",
"name": "renewal_date",
"type": "Date/Time"
}
}
}