Skip to main content
GET
Get Business Colors

Get Business Colors

Returns a key-value map of colour tokens configured for a specific location. The portal uses these values to apply the operator’s brand palette at runtime, overriding the default theme. Colours are stored as CSS-compatible hex or RGB strings.

Authentication

Requires a valid customer bearer token.

Path Parameters

number
required
The numeric identifier of the location whose colour palette you want to retrieve.

Response

Returns a flat Record<string, string> object where each key is a colour token name and each value is a CSS colour string.

TypeScript Integration

Usage in Portal

Error Responses

error
The bearer token is missing, expired, or invalid.
error
No location with the given businessId was found.