Data

List the documents

The documents of a collection, newest first. Follow next_cursor while has_more is true, or pass before to start at a point in time. filter matches top-level fields exactly: filter={"status":"new"} returns only documents whose status is new.

get/collections/{id}/documents

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/collections/{id}/documents
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: data:read)

Path parameters

idstring required

The id of the collection, or its name.

Query parameters

limitinteger

Documents per page, default 25. A value above 100 is capped at 100.

cursorstring

The next_cursor of the previous page.

beforestring date-time

Only documents added before this moment, in ISO 8601.

filterstring

A JSON object of top-level fields and the exact value they must have (string, number, true, false or null), like {"status":"new"}. URL-encode it.

Response

A page of documents.

has_moreboolean required

Whether there is another page.

next_cursorstring nullable required

Pass this as cursor to get the next page.

Changes

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