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
idUUID or null
createdOndatetime or null
createdByUUID or null
updatedOndatetime or null
updatedByUUID or null
namestring or null
The name of the document.
currentDocumentVersionIdUUID or null
The id of the current document version.
documentSpaceIdUUID or null
The id of the document space.
documentSpaceobject or null
parentIdUUID or null
The id of the document's parent document.
projectIdUUID or null
The id of the project this document references.
projectobject or null
taskIdUUID or null
The id of the task this document references.
emojistring or null
The emoji of the document.
isPrivateboolean or null
Whether the document is private.
orderdouble or null
The order of the document in either the list of private docs, the referenced document space or in the referenced project.
isExternalboolean or null
Whether the document belongs to an external project.
isHiddenForConnectUsersboolean or null
Whether the document is hidden for connect users.
contributorslist of objects or null
The contributors of this document.
teamslist of objects or null
The teams this document is connected to.
workspaceAccessLevelstring or null

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 null
The id of the document the workspace access level permission has been inherited from.
inheritedWorkspaceAccessFromDocumentobject or null
movedToTrashOndatetime or null
The date the document has been moved to the trash
movedToTrashByUUID or null
The id of the user that moved the document to the trash.
rootDocumentCreatedByUUID or null
The user id of the creator of the root document of this document's document tree.