Download one of a brand's own templates, in a portal

GET

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

curl --request GET \
  --url http://localhost:3000/api/v1/portal/example/brands/example/office/templates/example

The file wearing the brand’s latest publish, behind the portal’s door: GET /api/v1/brand/office/templates/{id}.

No key needed.

Parameters

Path Parameters

slug

required

string

The portal’s address

brand

required

string

One of its brands, by slug

id

required

string

The template’s asset id, or the one a rule names it by

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"
  }
}