Get a contact

GET

/api/v1/contacts/{reference}

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/example"),
    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/example';
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/example \
  --header 'Authorization: Bearer <token>'

One contact, named by Azimea’s id (any contact, store ones included), by ext: or by email:

. The ext: and email: forms find only contacts your own systems created (API or import), not those a connected store brings: a store’s customers are found by their Azimea id. A reference in none of the three forms is refused with audience.contact_reference_invalid. Needs contacts:read.

Authorizations

ApiKey

Parameters

Path Parameters

reference

required

string

Responses

200

The contact, with its consent status, tags and custom attributes

application/json

object

isSuccess

boolean

value

One of:

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

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": {
    "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
  },
  "status": 0,
  "errors": [],
  "fieldErrors": null
}

401

Missing or invalid API key

403

The key lacks the contacts:read permission