Pages

List pages

Returns pages WITHOUT the heavy body (the full HTML/JSON document) and passwordHash by default — list views never render the body. Pass fields=full to restore body. Fetch a full page via GET /api/pages/{id}.

get/api/pages

Query parameters

agentIdstring
keystring

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

keyPrefixstring

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

Non-unique asset directory namespace (for example shared/ or personal/<user-id>/drafts/). Runtime write boundaries normalize and validate the canonical form.

limitinteger
offsetinteger nullable
fields'full' | 'slim'

Response

Page list with totals + share-URL pointers

totalinteger required
limitinteger required
offsetinteger required

Changes

Changed in 3 of the 104 revisions of this API.23

    • added the media type application/json for the response with the status

      response-media-type-added

    • added the new optional query request parameter key

      new-optional-request-parameter

    • added the new optional query request parameter keyPrefix

      new-optional-request-parameter

    • deleted the query request parameter key

      request-parameter-removed

    • deleted the query request parameter keyPrefix

      request-parameter-removed