List outlets

View as MarkdownOpen in Claude

Returns outlets for the tenant. Filter by provider via X-Provider header. If X-Provider is omitted, returns all outlets regardless of provider. Results are sorted alphabetically by name.

Authentication

X-Api-Keystring
API Key authentication via header

Headers

X-Tenant-IDstringOptional
Tenant identifier
X-ProviderstringOptional

POS provider name (validated against tenant settings)

Response

OK
storeslist of objects
totalinteger

Errors

400
Bad Request Error
401
Unauthorized Error