v1

latestOpenAPI 3.1.02026-08-066984441.1 MB

documentSpaces

Returns all document spaces.

<Check title="Required Permissions" icon="key">The user must have at least read permissions to see a document space.</Check>

get/documentspaces

pageinteger

Page number for pagination

pageSizeinteger

Number of items per page

orderbystring

The properties to order by

filterbystring

The filter expression to filter by

Authorizationstring required

Bearer authentication

idstring uuid

The id of the entity.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

namestring nullable

The name of the document space.

isExternalboolean

Whether this document space is coming from an external workspace (awork Connect).

emojistring nullable

The emoji of the document space.

colorstring nullable

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

ordernumber double nullable

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

workspaceAccessLevelstring nullable

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