---
title: "List documents"
method: GET
path: "/api/documents"
tags: ["Documents"]
---

# List documents

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

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.

## Query parameters

- `websiteId` string
- `locale` string
- `documentId` string
- `category` string
- `published` boolean
- `search` string
- `pagination` 'cursor'
- `cursor` string
- `limit` integer
- `skip` integer
- `fields` string

## Response `200`

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

---

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