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}

Try it

Get Contact Attribute Key by ID

cURL

curl --request GET \
  --url https://{baseurl}/api/v1/management/contact-attribute-keys/{contactAttributeKeyId} \
  --header 'x-api-key: <x-api-key>'

200

{
  "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

x-api-key · string · required

Path Parameters

contactAttributeKeyId · string · required

The ID of the contact attribute key to retrieve

Response

200

application/json

OK

data · object

Show child attributes

data. createdAt · string<date-time>

Timestamp when the attribute key was created

data. description · string

Detailed description of what this attribute represents

data. environmentId · string

ID of the environment this attribute key belongs to

data. id · string

Unique identifier for the attribute key

data. isUnique · boolean

Whether this attribute must have unique values across contacts

data. key · string

The machine-readable identifier for the attribute

data. name · string

Human-readable name for the attribute

data. type · string

The type of attribute (e.g., "default")

data. updatedAt · string<date-time>

Timestamp when the attribute key was last updated