TOtopi
branding

Get an offer's branding

Changed on

Fetch the branding info for a specific offer to display in the app

get/branding/offers/{id}

Request

  • Base URL
    https://api.topi-staging.eu
  • URL
    https://api.topi-staging.eu/branding/offers/{id}
  • Auth
    OAuth 2
    Authorization code: /oauth2/authorize
    Token URL: /oauth2/token scopes: branding:read

Path parameters

idstring regexp required

Offer ID

Example:739b63c2-9e58-4964-b38d-4ebb424de242

Response

OK response.

is_co_brandingboolean

Whether the shop has a brand of its own, shown in addition to the platform brand

logo_urlstring

Url for the logo to display, if any

short_namestring

Short brand identifier (lowercase letters, digits and underscores) used to resolve brand assets

Example response

{
  "brand_values": {
    "focus_color": "abc123",
    "primary_color": "abc123",
    "primary_color_hover": "abc123",
    "primary_color_muted": "abc123",
    "primary_color_pressed": "abc123",
    "primary_color_tint": "abc123",
    "text_color_on_primary": "abc123",
    "text_size_scale": 1
  },
  "is_co_branding": false,
  "logo_url": "abc123",
  "short_name": "abc123"
}

Changes