---
title: "List the documents"
method: GET
path: "/collections/{id}/documents"
tags: ["Data"]
---

# List the documents

`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`)

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.

## Path parameters

- `id` string, required

## Query parameters

- `limit` integer
- `cursor` string
- `before` string, date-time
- `filter` string

## Response `200`

A page of documents.

- DocumentList
  - `data` Document[], required: The documents, newest first.
    - `id` string, uuid, required: The id of the document.
    - `collection_id` string, uuid, required: The id of its collection.
    - `data` object, required: The document itself: a JSON object.
    - `source` 'api' | 'public', required: api: added with an API key. public: sent from a form on a website.
    - `created_at` string, date-time, required: When the document was added.
    - `updated_at` string, date-time, required: When the document last changed.
    - `test` boolean, required: true for a document of a test project. No email was sent for it.
  - `has_more` boolean, required: Whether there is another page.
  - `next_cursor` string, nullable, required: Pass this as cursor to get the next page.

## Other responses

- `400`: Bad Request: invalid_parameter.
- `401`: Unauthorized: unauthorized, missing_api_key, invalid_api_key, api_key_revoked, project_deleted.
- `403`: Forbidden: project_not_enabled, key_mode_mismatch, missing_scope, verification_required.
- `404`: Not Found: not_found.
- `429`: Too Many Requests: rate_limited.
- `500`: Internal Server Error: internal_error.
- `503`: Service Unavailable: service_unavailable.

---

[API](https://skmtc.dev/hypamoon/apis/hypamoon-api.md) · [All operations](https://skmtc.dev/hypamoon/apis/hypamoon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hypamoon/apis/hypamoon-api/revisions/9f0b90004c06?raw)