Skip to content

List a project's documents

GET
/api/v1/documents
curl --request GET \
--url https://app.avera.io/api/v1/documents

Returns every document item in the project, rich-text and file documents alike, with the folder each sits in. Detail, lifecycle transitions and version history are served by the generic item endpoints, since documents are items in the meta-model.

projectId
string format: uuid

OK

Media type*/*
Array<object>
object
number
required
string
canonicalId
required
string format: uuid
title
string | null
description
string | null
contentType
string | null
documentTypeId
required
string
status
required
string
Allowed values: DRAFT REVIEW RELEASED OBSOLETE
seq
required
integer format: int64
revision
string | null
folderId
string | null format: uuid
folderName
string | null
fileName
string | null
fileSize
integer | null format: int64
mimeType
string | null
modifiedAt
required
string format: date-time
modifiedBy
required
string format: uuid
createdAt
required
string format: date-time
createdBy
required
string format: uuid