A brand's Office template, in a portal

GET

/api/v1/portal/{slug}/brands/{brand}/office

curl --request GET \
  --url 'http://localhost:3000/api/v1/portal/example/brands/example/office?format=potx'

One of the portal’s brands as a PowerPoint (potx) or Word (dotx) template, from its latest publish, behind the same door as the portal (see GET /api/v1/portal/{slug}); a brand never published is a 404. What it carries: GET /api/v1/brand/office.

No key needed.

Parameters

Path Parameters

slug

required

string

The portal’s address

brand

required

string

One of its brands, by slug

Query Parameters

format

string

default: potx

Allowed values: potx dotx

Potx: a PowerPoint template; dotx: a Word template

Responses

200

The template (binary)

401

Not in yet: how to get in

Media typeapplication/json

object

error

required

object

code

required

string

Allowed value: password

message

required

string

detail

required

object

name

required

string

access

required

string

Allowed values: password members

theme

required

object

logo

required

A URL on this host: the portal’s, else its first brand’s mark, else its organization’s

string | null

accent

required

The portal’s, else its first brand’s color, else its organization’s

string | null

background

required

string | null

icon

required

The organization’s, for the browser tab

string | null

product

required

What the organization calls the product

string

Example

{
  "error": {
    "code": "password",
    "detail": {
      "access": "password"
    }
  }
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}