Skip to content
Artbucket

A brand's own Office templates, in a portal

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

The PowerPoint, Word and Excel files on the brand’s latest publish, behind the portal’s door, only those that may leave the team, each with its check: GET /api/v1/brand/office/templates.

No key needed.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

The portal’s address

brand
required
string

One of its brands, by slug

Responses

Section titled “Responses”

200

Section titled “200”

The templates

Media typeapplication/json
object
data
required
Array<object>
object
id
required

The file’s asset id, at its latest version: download it at /api/v1/brand/office/templates/{id}

string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
filename
required
string
title
required
string | null
kind
required
string
Allowed values: potx pptx dotx docx xltx xlsx
app
required
string
Allowed values: PowerPoint Word Excel
error
required

Why the file can’t be read; null when it can

string | null
themes
required

Theme parts in it: none, and only its images follow the brand

integer
>= -9007199254740991 <= 9007199254740991
colors
required

Colors written on shapes or runs that aren’t the brand’s, most used first

Array<object>
object
value
required
string
count
required
integer
>= -9007199254740991 <= 9007199254740991
fonts
required

Faces written on shapes or runs that aren’t the brand’s heading or text family

Array<object>
object
name
required
string
count
required
integer
>= -9007199254740991 <= 9007199254740991
images
required

Its images: how many the library has, and how many a download replaces with a newer version

object
total
required
integer
>= -9007199254740991 <= 9007199254740991
library
required
integer
>= -9007199254740991 <= 9007199254740991
updated
required
integer
>= -9007199254740991 <= 9007199254740991
follows
required

Everything in it follows a release: a theme, nothing written outside it, every image the library’s

boolean
Example
{
  "data": [
    {
      "kind": "potx",
      "app": "PowerPoint"
    }
  ]
}

401

Section titled “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

Section titled “default”

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}