Get Portal Branding Image
GET/api/portal/branding/:type
The merchant's uploaded portal logo or square mark, as the image file itself. Public — no token needed; the tenant comes from the host — so sign-in pages and email clients can load it. This is the URL that logo_url / mark_url point to for uploaded images.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Responds with the image (image/png, image/jpeg, image/webp or a sanitised image/svg+xml) and Cache-Control: public, max-age=86400. Returns 404 when no image of that type has been uploaded. Rate limited to 240 requests per minute.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not Found
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.