List customers

Scope

• ecommerce:read Read e-commerce – the person behind the key must be all members.

Path parameters

store_idstringrequired

The store's ID, which you choose.

Query parameters

limitinteger

The maximum number of items in the response (1–500, default 100).at least 1 · at most 500 · default 100

cursorstring

next_cursor from the previous response, for the next page. Omit for the first page.

updated_sincestring

Only what has changed since then (ISO 8601).

Response

200 A page of customers.

dataarray<object>required

data[].idstringrequired

data[].emailstringrequired

data[].first_namestring | nullrequired

data[].last_namestring | nullrequired

data[].companystring | nullrequired

data[].contact_idstring | nullrequired

The workspace's contact with the same address, if there is one. A customer never becomes a contact on its own.

data[].orders_countintegerrequired

Paid orders.

data[].total_spentnumberrequired

The total of the paid orders.

data[].last_order_atstring (time, ISO 8601) | nullrequired

The most recent paid order.

data[].created_atstring (time, ISO 8601)required

When the customer was first sent in.

data[].updated_atstring (time, ISO 8601)required

When the customer was last changed.

has_morebooleanrequired

There are more: fetch the next page with cursor=next_cursor.

next_cursorstring | nullrequired

Send as cursor for the next page. null on the last page.

Errors

401

unauthenticatedinvalid_keykey_revokedkey_expiredkey_inactive

402

payment_required

403

insufficient_scopeforbiddenworkspace_suspended

404

not_found

422

validation_failed

429

rate_limited

500

internal_error