Get POS Settings
GET/api/pos/settings
Return the register's operational settings. Requires a Bearer token with pos.operate.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Includes the master enabled flag, the require_customer and auto_print_receipt behaviour toggles, the active card payment_processor (square|stripe), the Square square_location_id, and the list of available_processors. The admin-facing toggles are also editable via PUT /api/v2/settings/pos.
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.