Skip to main content
GET
List documents

Authorizations

Authorization
string
header
required

Use Authorization: Bearer

Path Parameters

project_id
string<uuid>
required

UUID of the project

Query Parameters

limit
integer
default:100

Maximum number of results per page

Required range: 1 <= x <= 1000
offset
integer
default:0

Number of results to skip for pagination

Required range: x >= 0

Case-insensitive search over document id and name.

status
enum<string>
default:active

Which documents to include by deletion status.

Available options:
active,
all,
deleted
collection
string

Filter by collection (the Document.collection foreign key). Pass a collection slug to return documents whose collection matches it; pass the sentinel __none__ for the "Default" bucket (documents with no collection).

ordering
enum<string>

Field to order results by. Prefix with - for descending. Defaults to name (ascending) when omitted. id is always appended as a stable tiebreaker. collection__name orders by the related collection name; documents in the "Default" bucket (no collection) group together.

Available options:
created_at,
-created_at,
name,
-name,
collection__name,
-collection__name

Response

Successful response

count
integer

Total number of results

next
string<uri> | null

URL to next page of results

previous
string<uri> | null

URL to previous page of results

results
object[]