API reference/Pages

Get a page

Try it

One draft page with its sections in order.

GET/api/v1/sites/{site_id}/pages/{page_id}

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the sites:read scope — read sites, pages and sections.

sites:readRead onlyMCP tool: get_page

Parameters

Named placeholders go in the path; the rest in the query string.

site_idstringPath · required: The site's id.1 to 100 characters
page_idstringPath · required: The page's id.1 to 100 characters

Response

200 with JSON on success (schema on the right). Errors use the standard envelope.

curl

curl -X GET 'https://websites.workflowcorp.com/api/v1/sites/SITE_ID/pages/PAGE_ID' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"

Example arguments

{
  "site_id": "SITE_ID",
  "page_id": "PAGE_ID"
}

Response schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "slug": {
      "type": "string",
      "description": "\"\" for the home page."
    },
    "path": {
      "type": "string",
      "description": "Where it lives on the site, e.g. /about."
    },
    "is_home": {
      "type": "boolean"
    },
    "parent_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "position": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "show_in_nav": {
      "type": "boolean"
    },
    "hidden": {
      "type": "boolean",
      "description": "Hidden pages stay in the draft and are never published."
    },
    "hide_from_search": {
      "type": "boolean",
      "description": "Hidden from search engines: noindex, left out of sitemap.xml and site search (the draft's setting; live with the next publish)."
    },
    "seo_title": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "seo_description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "section_count": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "is_sample": {
      "type": "boolean"
    },
    "sections": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "page_id": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "type_label": {
            "type": "string"
          },
          "position": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "hidden": {
            "type": "boolean"
          },
          "content": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {},
            "description": "The section's content; its shape is the type's content_schema (List section types)."
          },
          "is_sample": {
            "type": "boolean"
          },
          "saved_section_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Set when this is a LINKED placement of a saved section (Saved sections): its content is the saved section's."
          }
        },
        "required": [
          "id",
          "page_id",
          "type",
          "type_label",
          "position",
          "hidden",
          "content",
          "is_sample",
          "saved_section_id"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "title",
    "slug",
    "path",
    "is_home",
    "parent_id",
    "position",
    "show_in_nav",
    "hidden",
    "hide_from_search",
    "seo_title",
    "seo_description",
    "section_count",
    "is_sample",
    "sections"
  ],
  "additionalProperties": false
}