Get Contact Attribute Key by ID
API v1 Documentation
Client API > Response
Client API > Contacts
Client API > Display
Client API > Environment
Client API > User
Management API > Action Class
Management API > Attribute Class
Management API > Contact Attribute Keys
Management API > Contact Attributes
Management API > Contacts
Management API > Me
Management API > People
Management API > Response
Management API > Storage
Management API > Survey
Management API > Webhook
Health
Get Contact Attribute Key by ID
Retrieve a specific contact attribute key by its ID. This returns detailed information about how a particular attribute is defined in your environment.
GET
/
api
/
v1
/
management
/
contact-attribute-keys
/
{contactAttributeKeyId}
curl --request GET \
--url http:///%7B{baseurl}%7D/api/v1/management/contact-attribute-keys/{contactAttributeKeyId} \
--header 'x-api-key: <x-api-key>'
{
"data": {
"createdAt": "2024-11-07T12:25:48.589Z",
"description": "The email of the person",
"environmentId": "cm37a748d0008hbwhqvvuba23",
"id": "cm37a748d000ahbwhd5bbwc09",
"isUnique": true,
"key": "email",
"name": "email",
"type": "default",
"updatedAt": "2024-12-03T13:30:28.620Z"
}
}
Headers
Path Parameters
The ID of the contact attribute key to retrieve
Response
200
application/json
OK
Timestamp when the attribute key was created
Detailed description of what this attribute represents
ID of the environment this attribute key belongs to
Unique identifier for the attribute key
Whether this attribute must have unique values across contacts
The machine-readable identifier for the attribute
Human-readable name for the attribute
The type of attribute (e.g., "default")
Timestamp when the attribute key was last updated
Was this page helpful?
curl --request GET \
--url http:///%7B{baseurl}%7D/api/v1/management/contact-attribute-keys/{contactAttributeKeyId} \
--header 'x-api-key: <x-api-key>'
{
"data": {
"createdAt": "2024-11-07T12:25:48.589Z",
"description": "The email of the person",
"environmentId": "cm37a748d0008hbwhqvvuba23",
"id": "cm37a748d000ahbwhd5bbwc09",
"isUnique": true,
"key": "email",
"name": "email",
"type": "default",
"updatedAt": "2024-12-03T13:30:28.620Z"
}
}