API reference/Pages

List pages

Try it

The site's DRAFT pages in menu order (hidden ones included). What is live is the last published version.

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

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: list_pages

Parameters

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

site_idstringPath · required: The site'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' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"

Example arguments

{
  "site_id": "SITE_ID"
}

Response schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "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"
          }
        },
        "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"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}