Skip to content

Read page

Reads one custom page, its body too when asked.

Needs the read scope.

Call

  • Tool: get_page
  • Scope: read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
page object Yes
preview string No
include array of "body" No What else the read answers: body reads the body whole, as readBody does, and fails the read where readBody would.
{
  "type": "object",
  "properties": {
    "page": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "preview": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "include": {
      "description": "What else the read answers: `body` reads the body whole, as `readBody` does, and fails the read where `readBody` would.",
      "type": "array",
      "items": {
        "type": "string",
        "const": "body"
      },
      "maxItems": 1
    }
  },
  "required": [
    "page"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
files object Yes
maps array of object Yes The maps the body’s map blocks show, matched to a block by latitude and longitude; none while the body is kept from the reader.
body object or null Yes
attachments array of object Yes
access string Yes
id string Yes
slug string Yes
path string Yes The storefront path.
url string or null Yes The absolute URL on the store’s verified hostname, or null before it has one.
title string Yes
description string or null Yes
menu_position number or null Yes
published_at string or null Yes
created_at string or null Yes
updated_at string or null Yes
settings object Yes

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close