List contacts

GET

/api/v1/contacts

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://dashboard.azimea.com/api/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://dashboard.azimea.com/api/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://dashboard.azimea.com/api/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

ApiKey

Parameters

Query Parameters

segment

string format: guid

nullable

Example

01a10a3c-6b7d-7c52-8e1f-2a3b4c5d6e7f

page

required

integer format: int32

Example

pageSize

required

integer format: int32

Example

Responses

200

A page of contacts with the total count

application/json

object

isSuccess

boolean

value

One of:

object

object

items

Array<object>

object

string format: guid

storeId

string format: guid

nullable

email

string

firstName

string

nullable

lastName

string

nullable

phone

string

nullable

city

string

nullable

countryCode

string

nullable

consentStatus

string

Allowed values: Unknown SoftOptIn Subscribed Unsubscribed Bounced Complained CheckoutStarted PendingConfirmation

isPayingCustomer

boolean

orderCount

integer format: int32

totalSpent

number format: decimal

lastOrderAt

string format: date-time

nullable

sourceCreatedAt

string format: date-time

nullable

lastSyncedAt

string format: date-time

nullable

fromOrders

boolean

consentSource

string

nullable

consentUpdatedAt

string format: date-time

nullable

storeConsentMode

One of:

string

string

Allowed values: Explicit Notice OwnConsent None

marketingDeclared

boolean

tags

Array<string>

nullable

attributes

object

key

additional properties

lastOpenAt

string format: date-time

nullable

lastClickAt

string format: date-time

nullable

lastEmailedAt

string format: date-time

nullable

language

string

nullable

addedAt

string format: date-time

nullable

lastConversionAt

string format: date-time

nullable

page

integer format: int32

pageSize

integer format: int32

totalCount

integer format: int32

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": {
    "items": [
      {
        "id": "01a10a3c-5e2f-7b41-9c0d-4f7a2b6e1d90",
        "storeId": null,
        "email": "ana.popescu@example.com",
        "firstName": "Ana",
        "lastName": "Popescu",
        "phone": "+40721000000",
        "city": "Cluj-Napoca",
        "countryCode": "RO",
        "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": "ro",
        "addedAt": "2026-10-05T09:30:00+00:00",
        "lastConversionAt": null
      }
    ],
    "page": 1,
    "pageSize": 100,
    "totalCount": 1
  },
  "status": 0,
  "errors": [],
  "fieldErrors": null
}

400

Validation failed: see errors[].code and fieldErrors

application/problem+json

object

statusCode

integer format: int32

default: 400

message

string

default: One or more errors occurred!

errors

object

key

additional properties

Array<string>

Example

{
  "statusCode": 400,
  "message": "One or more errors occurred!"
}

401

Missing or invalid API key

403

The key lacks the contacts:read permission