List customers
The studio's customers - the customer record, not one order's snapshot - for syncing with a CRM.
Only live customers with at least one order are listed, the one with the most recent order first
(ties by id). Erased customers are not listed; GET /customers/{id} still answers for them.
Requires the customers:read scope; a publishable key cannot call it.
ApiKeyAuth customers:readAuthorizationBearer <shyni_sk_live_*>An API key, issued once and never retrievable again: an organization key in the developer
portal, or a studio key in the studio's admin (Moje studio → API). Send as Authorization: Bearer shyni_sk_live_....
Scope: customers:read
search?stringFree-text match on the customer's name, contacts and the name, phone and e-mail on their orders, as in the studio's own customer search. Fewer than 2 characters means no search.
externalRef?stringFilter to the customer that carries this externalRef (exact match; at most one, as it is unique per studio).
page?integer1 <= value1perPage?integer1 <= value <= 10020A page of customers.
application/json- response
data?array<>meta?curl -X GET 'https://api.shyni.io/api/v1/customers' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY'Response 200
A page of customers.
{ "data": [ { "id": "string", "name": "string", "email": "string", "phone": "string", "contacts": [ { "type": "EMAIL", "value": "string", "lastUsedAt": "2019-08-24T14:15:22Z" } ], "subjects": [ { "id": "string", "type": "string", "variant": "string", "attributes": { "property1": "string", "property2": "string" }, "note": "string", "externalRef": "string" } ], "note": "string", "externalRef": "string", "orderCount": 0, "firstOrderAt": "2019-08-24T14:15:22Z", "lastOrderAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "anonymizedAt": "2019-08-24T14:15:22Z" } ], "meta": { "page": 0, "perPage": 0, "total": 0 }}Response 400
A parameter, header or request body is missing, malformed, or out of range. A request body property the endpoint does not define answers UNKNOWN_FIELD instead, with field naming it.
{ "code": "INVALID_INPUT", "message": "Parameter perPage must be between 1 and 100."}Response 401
Missing, malformed, unknown, or revoked API key (INVALID_API_KEY).
{ "code": "INVALID_API_KEY", "message": "Missing or invalid API key."}Response 403
The key is valid but the request is refused. Branch on code: INSUFFICIENT_SCOPE (the key lacks the
permission this endpoint requires), PLAN_REQUIRED (the studio is not on a plan that includes API keys,
Pro and above), ORIGIN_NOT_ALLOWED, SECRET_KEY_IN_BROWSER, or DEMO_STUDIO on a write to the demo studio.
See Authentication and Scopes above.
{ "code": "INSUFFICIENT_SCOPE", "message": "This API key does not have the permission this endpoint requires."}Response 429
Burst rate limit exceeded.
{ "code": "RATE_LIMITED", "message": "Too many requests. Retry after the time given in the Retry-After header."}