Skip to content
Artbucket

The brand's own Office templates

GET
/api/v1/brand/office/templates
curl --request GET \
  --url http://localhost:3000/api/v1/brand/office/templates \
  --header 'Authorization: Bearer <token>'

The PowerPoint, Word and Excel files (pptx, potx, docx, dotx, xlsx, xltx) on a release’s rules, each at its latest version, approved and usable now, that the caller may see. Put one on a rule (a templates.slides rule, say) as a logo is. Each says what in it won’t follow the brand: colors and faces written on shapes and runs instead of taken from its theme, and images the library doesn’t have.

Scope: read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
brand
string

A brand’s slug; the default brand without it

version
string

A release’s number; live, the release readers see, without it

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

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