Get Contact Custom Field
Returns information about a specific contact custom field.
Endpoint
GET
v5/contactcustomfield/{field_id}
Requires authentication
Path Parameters
The custom field to retrieve.
field_id
string
required
The ID of the contact custom field to retrieve.
Query Parameters
This endpoint does not accept additional query parameters beyond authentication credentials.
None
Response
Returns a single contact custom field object.
result_ok
boolean
Whether the request succeeded.
data
object
The contact custom field object.
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/YOUR_FIELD_ID?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET"
Response
{
"result_ok": true,
"data": {
"id": "1",
"name": "customer_id",
"type": "Number"
}
}