Customer Lookup (Quick Search)
GET/api/customers/lookup
Lightweight customer quick-search used by the POS register to attach a customer at checkout. Returns a compact card per customer including the live store-credit wallet balance (summed in one join, N+1-safe), the assigned pricing tier, and tax-exemption status. Archived customers are excluded.
customers:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Query params: q (optional; matches name/company/email/phone), limit (optional; 1–50, default 15).
Authentication: Requires Bearer token (PAT).
Request
Responses
- 200
- 401
- 403
- 422
- 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.
Unprocessable Entity
Response Headers
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.