Skip to navigation
Customers

List customers

View as Markdown

The store’s registered customers, newest first. Requires customers:read. Needs customer registration on in the store settings (409 registration_disabled otherwise).

Authentication

AuthorizationBearer

An API key from the store's admin: חנות > API ומפתחות. Send it as Authorization: Bearer coi_sk_... (or X-Api-Key: coi_sk_...). Never in the URL - ?apikey= is refused with 400.

Query parameters

limitintegerOptional1-100Defaults to 50
Rows per page, 1 to 100.
cursorstringOptional

nextCursor from the previous page, as is. Omit for the first page.

emailstringOptionalformat: "email"
Find one customer by exact email.
created_sincestringOptional

Only customers registered from then on. ISO 8601: 2026-09-27 or 2026-09-27T10:00:00+03:00.

Response

A page of customers.
oktrueOptional
datalist of objectsOptional
hasMorebooleanOptional
Whether there is another page.
nextCursorstring or nullOptional

Pass as cursor for the next page; null on the last page.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error