Skip to content
AzimeaDocs
Dashboard
GET
/contacts
curl --request GET \
--url 'https://api.azimea.com/v1/contacts?segment=01a10a3c-6b7d-7c52-8e1f-2a3b4c5d6e7f&page=1&pageSize=100' \
--header 'Authorization: Bearer <token>'

A page of the company’s contacts for its own systems, newest first: everyone (store, import and API contacts alike), or only the people of one segment (segment, an id from GET /segments), the same people a campaign or a flow aimed at that segment would reach. page from 1, pageSize 1 to 200 (default 50); totalCount tells how many pages there are. Needs contacts:read.

segment
string format: guid
nullable
Example
01a10a3c-6b7d-7c52-8e1f-2a3b4c5d6e7f
page
required
integer format: int32
Example
1
pageSize
required
integer format: int32
Example
100

A page of contacts with the total count

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.

object
items

The contacts on this page, newest first.

Array<object>
object
id

Azimea’s id for this contact.

string format: guid
storeId

The connected store the contact comes from; null for contacts your own systems made (the API or an import).

string format: guid
nullable
email

The contact’s email address.

string
firstName

First name.

string
nullable
lastName

Last name.

string
nullable
phone

Phone number, as it was given.

string
nullable
city

City.

string
nullable
countryCode

Two-letter country code (ISO 3166-1), such as GB.

string
nullable
consentStatus

What Azimea may send this person. See the consent statuses catalog for what each value allows.

string
Allowed values: Unknown SoftOptIn Subscribed Unsubscribed Bounced Complained CheckoutStarted PendingConfirmation
isPayingCustomer

true once the person has a paid order.

boolean
orderCount

How many orders Azimea has recorded for them.

integer format: int32
totalSpent

How much they have spent in total, from their orders.

number format: decimal
lastOrderAt

When they last ordered; null if they never did.

string format: date-time
nullable
sourceCreatedAt

When the person was created in their store; null for contacts that do not come from a store.

string format: date-time
nullable
lastSyncedAt

When Azimea last updated this contact from the store; null for contacts that do not come from a store.

string format: date-time
nullable
fromOrders

true when they bought without a store account: known from orders only, missing from the store’s customer list.

boolean
consentSource

Where the consent basis comes from, such as store_import, store_purchase, signup_form or api.

string
nullable
consentUpdatedAt

When the consent status last changed.

string format: date-time
nullable
storeConsentMode

How the connected store collects consent: Explicit, Notice, OwnConsent or None. null until it is chosen.

string
nullable
Allowed values: Explicit Notice OwnConsent None
marketingDeclared

true once the store has declared how it collects consent. Until then no marketing goes to anyone in it.

boolean
tags

Free-form labels, added by a flow’s Tag step. Flows and segments can filter on them.

Array<string>
nullable
attributes

Your own fields, by key. Each value is stored as its field’s type.

object
key
additional properties
lastOpenAt

When the person last opened an email. A mail privacy feature or a link scanner opening it does not count.

string format: date-time
nullable
lastClickAt

When the person last clicked a link. A scanner clicking does not count.

string format: date-time
nullable
lastEmailedAt

When the last campaign, flow or cart email went out to them.

string format: date-time
nullable
language

The language they read, as a lowercase two-letter code (en, ro). It picks the language version of a campaign they get; null when not known.

string
nullable
addedAt

When the contact came into Azimea. What “new contacts” counts from.

string format: date-time
nullable
lastConversionAt

When they last did something your company counts as a conversion.

string format: date-time
nullable
page

The page number, starting at 1.

integer format: int32
pageSize

How many contacts a full page holds.

integer format: int32
totalCount

How many contacts match in all, across every page.

integer format: int32
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": {
"items": [
{
"id": "01a10a3c-5e2f-7b41-9c0d-4f7a2b6e1d90",
"storeId": null,
"email": "emma.clarke@example.com",
"firstName": "Emma",
"lastName": "Clarke",
"phone": "+447700900123",
"city": "Manchester",
"countryCode": "GB",
"consentStatus": "Subscribed",
"isPayingCustomer": false,
"orderCount": 0,
"totalSpent": 0,
"lastOrderAt": null,
"sourceCreatedAt": null,
"lastSyncedAt": null,
"fromOrders": false,
"consentSource": "api",
"consentUpdatedAt": "2026-10-05T09:30:00+00:00",
"storeConsentMode": null,
"marketingDeclared": false,
"tags": [
"trial"
],
"attributes": {
"plan": "pro",
"seats": 12
},
"lastOpenAt": null,
"lastClickAt": null,
"lastEmailedAt": null,
"language": "en",
"addedAt": "2026-10-05T09:30:00+00:00",
"lastConversionAt": null
}
],
"page": 1,
"pageSize": 100,
"totalCount": 1
},
"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