Pages

List a site's pages

One row per page, with its URL, layout, title, what it places (sections, menus, listings) and whether it has staged changes. A route that stands for many pages (a collection) appears as one row with a pattern. The rows come from an index, so no page bodies are read. Filter with q (path or title), layout or noLayout, flag (single chip), and page with limit and cursor. Pass group=layout for layout-key group order and pv3. cursors (default order keeps pv2.).

get/api/v1/sites/{slug}/pages

Request

  • Base URL: https://api.dotsy.ai
  • URL: https://api.dotsy.ai/api/v1/sites/{slug}/pages
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

slugstring required
Example:acme-studio

Site slug or site id (UUID). An old slug answers 301/308 and a site id 307 to the canonical slug path.

Query parameters

limitinteger

Page size, 1 to 1000. Defaults to 1000; larger values are clamped. Follow nextCursor for the rest.

cursorstring

Opaque value from the previous page's nextCursor.

qstring

Only pages whose path or title contains this text (case-insensitive).

layoutstring

Only pages that use this layout, by file key (layouts/default.html) or name (default).

noLayoutboolean

Only pages with no layout. Cannot be combined with layout.

flag'changes' | 'unpublished' | 'hidden' | 'test' | 'norule'

Only pages matching this chip (combines with other filters).

group'layout'

When layout, rows are ordered by layout file key (code unit), no-layout last, then path within each group. Cursors use the pv3. prefix.

pagesLimitinteger

Old name for limit. Use limit.

pagesCursorstring

Old name for cursor. Use cursor.

pagesQstring

Old name for q. Use q.

Response

One page of rows.

nextCursorstring nullable required

Pass as cursor (with the same limit) for the next page; null on the last page.

routesListTotalinteger nullable required

Rows that match the filter. null when the list is a partial window.

partialboolean required

True when the list is a window of the site rather than all of it.

Example response

{
  "routes": [
    {
      "path": "/about",
      "layout": "layouts/default.html"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.