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. <Check title="Required Permissions">Any authenticated user.</Check>

Authentication

AuthorizationBearer

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
idstring or nullformat: "uuid"
createdOnstring or nullformat: "date-time"
createdBystring or nullformat: "uuid"
updatedOnstring or nullformat: "date-time"
updatedBystring or nullformat: "uuid"
namestring or null
The name of the document space.
emojistring or null
The emoji of the document space.
colorstring or null
The color of the document space for display purposes in the app. Can be null when no color assigned.
orderdouble or null
The order of the document space in the list of document spaces.
workspaceAccessLevelstring or null

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 objects or null
The contributors of this document space.
teamslist of objects or null
The teams this document space is connected to.