API v1 ReferenceDocuments

Returns all documents.

To retrieve a document, the user has to at least have ‘read’ permissions for the document.

Required Permissions
Any authenticated user.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

includeTrashedDocumentsbooleanOptionalDefaults to false
Whether to also include trashed documents.
pageintegerOptionalDefaults to 1
Page number for pagination
pageSizeintegerOptionalDefaults to 10
Number of items per page
orderbystringOptional
The properties to order by
filterbystringOptional
The filter expression to filter by

Response

OK
idUUIDOptional
createdOndatetimeOptional
createdByUUIDOptional
updatedOndatetimeOptional
updatedByUUIDOptional
namestring or nullOptional
The name of the document.
currentDocumentVersionIdUUID or nullOptional
The id of the current document version.
documentSpaceIdUUID or nullOptional
The id of the document space.
documentSpaceobjectOptional
parentIdUUID or nullOptional
The id of the document's parent document.
projectIdUUID or nullOptional
The id of the project this document references.
projectobjectOptional
taskIdUUID or nullOptional
The id of the task this document references.
emojistring or nullOptional
The emoji of the document.
isPrivatebooleanOptional
Whether the document is private.
orderdouble or nullOptional
The order of the document in either the list of private docs, the referenced document space or in the referenced project.
isExternalbooleanOptional
Whether the document belongs to an external project.
isHiddenForConnectUsersbooleanOptional
Whether the document is hidden for connect users.
contributorslist of objectsOptional
The contributors of this document.
teamslist of objectsOptional
The teams this document is connected to.
workspaceAccessLevelstring or nullOptional

Determines the level of access to this document granted to all workspace users. Can be either not set (no access), read, or manage.

inheritedWorkspaceAccessFromDocumentIdUUID or nullOptional
The id of the document the workspace access level permission has been inherited from.
inheritedWorkspaceAccessFromDocumentobjectOptional
movedToTrashOndatetime or nullOptional
The date the document has been moved to the trash
movedToTrashByUUID or nullOptional
The id of the user that moved the document to the trash.
rootDocumentCreatedByUUIDOptional
The user id of the creator of the root document of this document's document tree.