Public: Pages

List a brand's pages

Pages with their route, title, status and languages. This is where a urlPath comes from: every other page route takes one. The live URL (liveUrl) is on the by-path route, and on list rows only with responseFormat=detailed.

A page is one route served in every language of the site. locales lists each language with the route it serves at there, the default language first at the page's own urlPath.

An archived page has left the site (its file or row is gone) and is listed only with status=archived.

Capped and paginated. When the cap bites the response carries a note saying how to narrow: filter by status or urlPathPrefix rather than paging through everything.

get/api/v1/public/brands/{brandSlug}/pages/

Request

  • Base URL: https://api.iterant.ai
  • URL: https://api.iterant.ai/api/v1/public/brands/{brandSlug}/pages/
  • Auth: HTTP bearer

Path parameters

brandSlugstring required

Query parameters

limitstring

1-100, default 20.

offsetstring

Rows to skip.

responseFormat'concise' | 'detailed'

How much to return. concise (the default) omits long-form text: briefs, outlines, evidence, passage excerpts, per-dimension breakdowns. detailed includes it and costs several times the tokens.

status'archived' | 'changed' | 'draft' | 'failed_generation' | 'generating' | 'polishing' | 'published' | 'review_required'

Only pages in this status. Without it, every page but the archived ones.

urlPathPrefixstring

Only routes starting with this prefix, e.g. "/blog/".

Response

totalinteger required

Rows matching the query, before limit and offset.

offsetinteger required

Rows skipped. Echoed back so a caller can page without bookkeeping.

limitinteger required

Cap actually applied, which may be lower than the one requested.

notestring required

How to narrow, when the cap hid rows. Empty when the response is the whole answer.

Changes

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