Skip to content
Artbucket

A brand's pages

GET
/api/v1/brands/{slug}/pages
curl --request GET \
  --url http://localhost:3000/api/v1/brands/example/pages \
  --header 'Authorization: Bearer <token>'

In order, with their tree fields, how many sections each has and the keys of the rules they show. GET one for its sections.

Scope: read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Brand slug

Responses

Section titled “Responses”

200

Section titled “200”

Pages

Media typeapplication/json
object
data
required
Array<object>
object
slug
required
string
title
required
string
position
required
integer
>= -9007199254740991 <= 9007199254740991
hidden
required
boolean
parent
required

The page it sits under; null at the top

string | null
eyebrow
required
string | null
lede
required
string | null
cover
required
Any of:
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)$/
icon
required
string | null
audience
required

On portals: who may read it

string
Allowed values: everyone partners members
tabs
required

Its child pages show as tabs across its top

boolean
aliases
required

Slugs it had before a rename: they still find it

Array<string>
layout
required

Landing: a front with no nav column, on-this-page or pager; book: a chapter

string
Allowed values: book landing
updatedAt
required

The last change to what it says

string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
revision
required

What it says, as a hash: send it back in If-Match (edit_page and save_page: revision) to refuse a write over a change you haven’t seen

string
sections
required

How many

integer
>= -9007199254740991 <= 9007199254740991
keys
required

The rules its sections show, by key: keys, items’ keys and background colors

Array<string>
Example
{
  "data": [
    {
      "audience": "everyone",
      "layout": "book"
    }
  ]
}

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