Skip to content

List contact fields

GET
/api/v1/contact-attributes
curl --request GET \
--url https://dashboard.azimea.com/api/v1/contact-attributes \
--header 'Authorization: Bearer <token>'

The company’s own contact fields (custom attributes), archived ones included, ordered by key: the keys you can send in a contact’s attributes and use in segment rules, each with its type (Text, Number, Boolean, Date, DateTime, TextList) and where it was created (Ui, Api, Csv). Needs contacts:read.

Every contact field definition

Media typeapplication/json
object
isSuccess
boolean
value
Array<object>
nullable
object
key
string
label
string
type
string
Allowed values: Text Number Boolean Date DateTime TextList
description
string
nullable
createdFrom
string
Allowed values: Ui Api Csv
createdAt
string format: date-time
archivedAt
string format: date-time
nullable
status
integer format: int32
errors
Array<object>
object
code
string
message
string
params
object
key
additional properties
fieldErrors
object
key
additional properties
Array<object>
object
code
string
message
string
params
object
key
additional properties
Example
{
"isSuccess": true,
"value": [
{
"key": "plan",
"label": "Plan",
"type": "Text",
"description": "The subscription plan the person is on.",
"createdFrom": "Api",
"createdAt": "2026-10-05T09:30:00+00:00",
"archivedAt": null
}
],
"status": 0,
"errors": [],
"fieldErrors": null
}

Missing or invalid API key

The key lacks the contacts:read permission