List Instances
GET/api/storefront/instances
Every Storefront integration instance on the tenant, ordered by name. Not paginated and not filterable — a tenant has a handful of connected stores, not a catalogue of them.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Each entry is the full instance representation: connection state, the canonical pricing and inventory settings, per-entity sync cursors, and live order/product counts. The API key is never returned; api_key_hint shows only its last four characters.
Authentication: Bearer token (session or PAT).
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.