The Page object

A Page is returned as a JSON object with object: "page". GET /pages/{id} extends the shape with a blocks[] array — the full ordered block tree, documented on Blocks.

Example

{
  "object": "page",
  "id": "c4d5e6f7-8a9b-4c0d-1e2f-3a4b5c6d7e8f",
  "slug": "fall-tasting",
  "public_slug": "fall-2024-tasting",
  "status": "active",
  "title": "Fall 2024 Tasting Notes",
  "description": "Six wines, six stories.",
  "background": {
    "type": "gradient",
    "value": "linear-gradient(to bottom right, #f9f4ec, #e6d6b8)",
    "animated": false
  },
  "island": {
    "color": "#ffffff",
    "opacity": 1,
    "shadow": "md",
    "roundness": "3xl"
  },
  "favicon_url": "https://files.awardee.com/orgs/.../favicon.ico",
  "meta_title": "Fall 2024 Tasting Notes — Reserve Wines",
  "meta_description": "Six wines, six stories. The full set of fall tasting notes.",
  "og_image_url": "https://files.awardee.com/orgs/.../og.jpg",
  "view_count": 8421,
  "created_at": "2024-08-30T15:01:09Z",
  "updated_at": "2026-05-12T11:42:00Z",
  "blocks": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "type": "heading",
      "config": { "text": "Fall 2024", "level": 1, "alignment": "center" },
      "sort_order": 0,
      "spacing_top": 0,
      "spacing_bottom": 16
    },
    {
      "id": "22222222-2222-4222-8222-222222222222",
      "type": "text",
      "config": {
        "content": "Six wines, six stories.",
        "alignment": "center"
      },
      "sort_order": 1,
      "spacing_top": 0,
      "spacing_bottom": 24
    },
    {
      "id": "33333333-3333-4333-8333-333333333333",
      "type": "image",
      "config": {
        "url": "https://files.awardee.com/orgs/.../tasting-hero.jpg",
        "fileName": "tasting-hero.jpg"
      },
      "sort_order": 2,
      "spacing_top": 0,
      "spacing_bottom": 24
    },
    {
      "id": "44444444-4444-4444-8444-444444444444",
      "type": "button",
      "config": {
        "label": "Reserve a tasting",
        "iconPosition": "end-gap",
        "destination": {
          "type": "url",
          "value": { "url": "https://example.com/book" }
        }
      },
      "sort_order": 3,
      "spacing_top": 0,
      "spacing_bottom": 0
    }
  ]
}

Identifiers

string

required

Always "page".

string (uuid)

required

Stable UUID. Use this in /pages/{id} and as the target of destination.page on QR codes and products.

string

required

Operator-facing slug. Editable in the dashboard. Used for internal dashboard navigation and as the default surface name when no public_slug is set.

string

required

The slug exposed in public page URLs. Distinct from slug because the operator may want a clean public address that’s independent of internal renames. Stable within the page’s life; changes only on explicit operator edit.

Status

string

required

One of draft, active, inactive, archived. See the overview for behaviour per status.

Content

string

required

Page title. Rendered in the editor’s tab and used as the default <title> when meta_title is unset.

string | null

Free-form description. Operator-facing — distinct from meta_description below.

Background

object

required

The page background. Discriminated on type: color, gradient, image, or video.

Show Background variants

{ "type": "color", "value": "#f9f4ec" }

value is any valid CSS colour string.

{
  "type": "gradient",
  "value": "linear-gradient(to bottom right, #f9f4ec, #e6d6b8)",
  "animated": false,
  "animatedStops": ["linear-gradient(...)", "linear-gradient(...)"]
}

value is a raw CSS gradient string. When animated is true, the renderer cycles through animatedStops (or a built-in cycle if unset).

{
  "type": "image",
  "url": "https://files.awardee.com/...",
  "overlayColor": "#000000",
  "overlayOpacity": 0.25
}

Overlay is optional. Use it to soften busy hero images.

{
  "type": "video",
  "url": "https://files.awardee.com/...",
  "poster": "https://files.awardee.com/..."
}

poster is shown while the video buffers.

Island

The “island” is the content card that sits on the background.

object

required

Show Island fields

string

required

Island background colour. Defaults to #ffffff.

number

required

0 (fully transparent) to 1 (fully opaque). Defaults to 1.

string

required

One of none, sm, md, lg, xl. Defaults to md.

string

required

One of none, sm, md, lg, xl, 2xl, 3xl. Defaults to 3xl.

Stats

integer

required

Lifetime view count. Increments on every public render. Read-only.

Timestamps

string (datetime)

required

When the page was created.

string (datetime)

required

Last mutation timestamp.

Blocks

GET /pages/{id} extends the response with a blocks[] array, ordered by sort_order. Each block has the envelope:

{
  "id": "block-uuid",
  "type": "heading",
  "config": {
    /* shape depends on type */
  },
  "sort_order": 0,
  "spacing_top": 0,
  "spacing_bottom": 0
}

See Blocks for the per-type config shape.

array

Ordered list of block objects. Empty for blank pages.

Get started

Identity

Concepts

Webhooks

Chatbots

Customers

Articles

Article Categories

Article Tags

Knowledge Bases

Conversations

Conversation Tags

Submissions

Pages

QR Codes

QR Groups

Products

Objects

Custom Domains

Custom Domain Routes

Team

Example

Identifiers

Status

Content

Background

Island

Meta

Stats

Timestamps

Blocks

​Example

​Identifiers

​Status

​Content

​Background

​Island

​Meta

​Stats

​Timestamps

​Blocks

Example

Identifiers

Status

Content

Background

Island

Meta

Stats

Timestamps

Blocks