List Portal Brands
GET/api/admin/portal/branding/stores
List every brand a dealer can see: the portal default first, then one card per active store, with archived stores apart (their saved branding is kept and returns on unarchive).
customers:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Each card: id (null for the portal default), name, company_name, portal_slug, is_default, customised (the store sets at least one field of its own; for the default, any merchant branding), uses_own_brand (whether the store's dealers see a brand of their own — false for an archived store, and for the tenant's default store while it has no override), dealer_count (customers on that store with portal access; for the default: customers with no or an archived store, plus those on an active store without a brand of its own), archived, archived_at, sign_in_url (the public sign-in page, with ?store={portal_slug} for a store; null when the store has no slug yet), document_logo_available (the store has an uploaded document logo that can be copied into its portal logo), branding (the buyer-facing branding its dealers actually see), inherited (per field, whether the store falls back to the portal default) and warnings (contrast warnings for colours set at that level).
Also returns active_store_count.
Requires a staff bearer token with the portal.manage permission.
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.