List contacts
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://api.azimea.com/v1/contacts?segment=01a10a3c-6b7d-7c52-8e1f-2a3b4c5d6e7f&page=1&pageSize=100"), Headers = { { "Authorization", "Bearer <token>" }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://api.azimea.com/v1/contacts?segment=01a10a3c-6b7d-7c52-8e1f-2a3b4c5d6e7f&page=1&pageSize=100';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Example
01a10a3c-6b7d-7c52-8e1f-2a3b4c5d6e7fExample
1Example
100Responses
Section titled “Responses”A page of contacts with the total count
object
true when the call worked, false when errors say why it did not.
The answer itself; null when the call failed.
object
The contacts on this page, newest first.
object
Azimea’s id for this contact.
The connected store the contact comes from; null for contacts your own systems made (the API or an import).
The contact’s email address.
First name.
Last name.
Phone number, as it was given.
City.
Two-letter country code (ISO 3166-1), such as GB.
What Azimea may send this person. See the consent statuses catalog for what each value allows.
true once the person has a paid order.
How many orders Azimea has recorded for them.
How much they have spent in total, from their orders.
When they last ordered; null if they never did.
When the person was created in their store; null for contacts that do not come from a store.
When Azimea last updated this contact from the store; null for contacts that do not come from a store.
true when they bought without a store account: known from orders only, missing from the store’s customer list.
Where the consent basis comes from, such as store_import, store_purchase, signup_form or api.
When the consent status last changed.
How the connected store collects consent: Explicit, Notice, OwnConsent or None. null until it is chosen.
true once the store has declared how it collects consent. Until then no marketing goes to anyone in it.
Free-form labels, added by a flow’s Tag step. Flows and segments can filter on them.
Your own fields, by key. Each value is stored as its field’s type.
object
When the person last opened an email. A mail privacy feature or a link scanner opening it does not count.
When the person last clicked a link. A scanner clicking does not count.
When the last campaign, flow or cart email went out to them.
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.
When the contact came into Azimea. What “new contacts” counts from.
When they last did something your company counts as a conversion.
The page number, starting at 1.
How many contacts a full page holds.
How many contacts match in all, across every page.
An internal result number. Rely on the HTTP status code instead.
What went wrong, one entry per problem; empty when the call worked.
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
The same problems grouped by the request field they belong to; null when none is tied to a field.
object
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
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
object
true when the call worked, false when errors say why it did not.
The answer itself; null when the call failed.
An internal result number. Rely on the HTTP status code instead.
What went wrong, one entry per problem; empty when the call worked.
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
The same problems grouped by the request field they belong to; null when none is tied to a field.
object
object
A stable code such as audience.contact_not_found. Branch on this, never on message. Every code is listed in the error codes catalog.
An English sentence for your logs. Do not show it to end users: it can change.
The numbers the message mentions (a minimum, a maximum), when there are any.
object
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