Skip to content
AzimeaDocs
Dashboard
GET
/contact-attributes
curl --request GET \
--url https://api.azimea.com/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

true when the call worked, false when errors say why it did not.

boolean
value

The answer itself; null when the call failed.

Array<object>
nullable
object
key

The field’s key: lowercase letters, digits and _, starting with a letter, at most 40 characters. It never changes.

string
label

The name shown in the dashboard.

string
type

How values are stored and compared in segments. Fixed once the field exists.

string
Allowed values: Text Number Boolean Date DateTime TextList
description

A note for your team about what the field holds; null when none was written.

string
nullable
createdFrom

Where the field was made: the dashboard (Ui), the API (Api) or a file import (Csv).

string
Allowed values: Ui Api Csv
createdAt

When the field was created.

string format: date-time
archivedAt

When the field was archived; null while it is active. An archived field is hidden from pickers and keeps every stored value.

string format: date-time
nullable
status

An internal result number. Rely on the HTTP status code instead.

integer format: int32
errors

What went wrong, one entry per problem; empty when the call worked.

Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
fieldErrors

The same problems grouped by the request field they belong to; null when none is tied to a field.

object
key
additional properties
Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

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
}

Validation failed: see errors[].code and fieldErrors

Media typeapplication/json
object
isSuccess

true when the call worked, false when errors say why it did not.

boolean
value

The answer itself; null when the call failed.

nullable
status

An internal result number. Rely on the HTTP status code instead.

integer format: int32
errors

What went wrong, one entry per problem; empty when the call worked.

Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
fieldErrors

The same problems grouped by the request field they belong to; null when none is tied to a field.

object
key
additional properties
Array<object>
object
code

A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.

string
message

An English sentence for your logs. Do not show it to end users: it can change.

string
params

The numbers the message mentions (a minimum, a maximum), when there are any.

object
key
additional properties
Example
{
"isSuccess": false,
"value": null,
"status": 5,
"errors": [
{
"code": "validation.required",
"message": "Fill in this field.",
"params": null
}
],
"fieldErrors": {
"email": [
{
"code": "validation.required",
"message": "Fill in this field.",
"params": null
}
]
}
}

Missing or invalid API key

The key lacks the contacts:read permission

Too many requests for this key