Documents

List documents

Requires the documents:read scope. For stable traversal, set pagination=cursor; the response becomes {items, nextCursor} and is ordered by ascending _id. Pass nextCursor back as cursor until it is null. Existing array responses and offset pagination remain available when cursor pagination is not requested.

get/api/documents

Request

  • Base URL: https://api.supovia.com
  • URL: https://api.supovia.com/api/documents
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Query parameters

websiteIdstring
localestring
documentIdstring

Exact document id

categorystring
publishedboolean
searchstring

Plain-text title search

pagination'cursor'

Set to cursor for a stable page envelope

cursorstring

Opaque nextCursor from the preceding cursor page

limitinteger

Optional bounded page size (maximum 500 and default 100 in cursor mode; 0 returns everything otherwise)

skipinteger
fieldsstring

Comma-separated projection of fields to return

Response

Array of documents, or {items, nextCursor} in cursor mode

Changes

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