Sign in

v1

latestOpenAPI 3.1.02026-07-261344388.3 KB
Document

List documents

Retrieve a paginated list of documents for a project with optional filtering.

get/api/projects/{projectId}/documents

Path parameters

projectIdstring uuid required

Project unique identifier

Query parameters

parentIdstring uuid

Filter by parent document ID

'true' | 'false' | 'True' | 'False' | 'TRUE' | 'FALSE'
OR
boolean

Include only deleted documents

searchstring

Search documents by name

keystring

Get a single document by exact key

keysstring

Comma separated list of document keys to retrieve

'true' | 'false' | 'True' | 'False' | 'TRUE' | 'FALSE'
OR
boolean

Include ancestor documents

contentTypestring

Filter by content type (comma separated)

'true' | 'false' | 'True' | 'False' | 'TRUE' | 'FALSE'
OR
boolean

Return only directory documents

'true' | 'false' | 'True' | 'False' | 'TRUE' | 'FALSE'
OR
boolean

Return only direct children

pagenumber

Current page

perPagenumber

Number of items per page

Response

Paginated list of documents