Sign in
ops

listForContractualEntities branding

Changed on

Fetch all branding configurations linked to a contractual entity

get/ops/branding/contractual-entities

Request

  • Base URL: https://api.topi-staging.eu
  • URL: https://api.topi-staging.eu/ops/branding/contractual-entities
  • Auth: OAuth 2 (authorization code, authorization URL /oauth2/authorize, token URL /oauth2/token, scopes: ops-branding:read)

Response

OK response.

contractual_entitystring required

Code of the contractual entity the branding config is linked to

created_atstring date-time required
email_logo_urlstring

Url for the logo to display in emails, if any

enable_transactional_emailsboolean required

Whether or not to enable transactional emails

idstring regexp required

ID of branding config

info_hub_urlstring

Url for the info hub, if any

logo_urlstring

Url for the logo to display, if any

namestring required

Name of the branding config

short_namestring

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

updated_atstring date-time required

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
    },
    "contractual_entity": "peac_us_inc",
    "created_at": "1970-01-01T00:00:01Z",
    "email_logo_url": "abc123",
    "enable_transactional_emails": false,
    "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
    "info_hub_url": "abc123",
    "logo_url": "abc123",
    "name": "abc123",
    "short_name": "abc123",
    "updated_at": "1970-01-01T00:00:01Z"
  }
]

Changes