Skip to main content
GET
Get Workspace by ID

Path Parameters

workspaceId
string
required

Query Parameters

workspaceIds
string[]

List of comma-separated workspace ids

includeSettings
boolean

Include workspace settings

limit
string<int64>
offset
string<int64>

Response

OK

name
string<external-text>
required

Workspace name

Example:

"Bron Workspace"

tag
string<external-text>
required

Workspace tag

Example:

"bron"

workspaceId
string
required

The workspace ID

Example:

"2a0f2m25qyn3cen5hj"

icon
string

Workspace icon: image path (e.g. 'workspaces/logos/abc.png') or 'emoji:' (e.g. 'emoji:🚀')

Example:

"emoji:🚀"