API v1 ReferenceDocument Spaces

Returns all document spaces.

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

Required Permissions
Any authenticated user.

Headers

AuthorizationstringRequired

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

Query parameters

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 space.

emojistring or nullOptional

The emoji of the document space.

colorstring or nullOptional

The color of the document space for display purposes in the app. Can be null when no color assigned.

orderdouble or nullOptional

The order of the document space in the list of document spaces.

workspaceAccessLevelstring or nullOptional

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

contributorslist of objectsOptional

The contributors of this document space.

teamslist of objectsOptional

The teams this document space is connected to.