Skip to main content
GET
List documents

Authorizations

Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

projectId
string<uuid>
required

Project unique identifier

Query Parameters

parentId
string<uuid>

Filter by parent document ID

deleted

Include only deleted documents

Available options:
true,
false,
True,
False,
TRUE,
FALSE

Search documents by name

key
string

Get a single document by exact key

keys
string

Comma separated list of document keys to retrieve

ancestors

Include ancestor documents

Available options:
true,
false,
True,
False,
TRUE,
FALSE
contentType
string

Filter by content type (comma separated)

directoriesOnly

Return only directory documents

Available options:
true,
false,
True,
False,
TRUE,
FALSE
directChildren

Return only direct children

Available options:
true,
false,
True,
False,
TRUE,
FALSE
page
number
default:1

Current page

perPage
number
default:10

Number of items per page

Response

200 - application/json

Paginated list of documents

Paginated list of documents

results
object[]
required

List of documents

paginate
object
required

Pagination metadata