Skip to main content
GET
Get Shop

Get Shop

Returns a curated, store-descriptive view of the shop account. The response is an allow-list of safe fields — financial data (balances, wallet / credit balances, payout state), billing and Stripe Connect identifiers, referral data, IP, 2FA state, POS permissions, and other internal account columns are never included, regardless of scope.

Request

Response

The response uses the standard envelope. The shop record is nested under data.shop.
integer
HTTP status code (e.g., 200)
string
Result state — success on success, error on failure
string
Human-readable message, or null on success
object
Response data wrapper
This endpoint returns only the allow-listed fields documented above. Account balances, wallet/credit balances, payout and billing state, Stripe Connect identifiers, referral data, IP, 2FA state, POS permissions, the login email, and every other internal column are never returned — a read_shop app sees only store-descriptive data.

Example Response

Error Response

Errors return the same envelope with state set to error and a message.