Skip to main content
GET
List Workspaces

List Workspaces

Return the workspaces the authenticated user belongs to.

Authentication & Scope

Requires the workspaces-read ability.

Request

No query parameters are supported.

Response

200 OK – An array of Workspace objects.
403 Forbidden – The token lacks workspaces-read or you do not have the necessary permissions.

Authorizations

Authorization
string
header
required

Personal Access Token

Response

Successful

id
number
read-only

The unique identifier for the workspace.

Example:

1

name
string

The name of the workspace.

Example:

"My Marketing Team"

icon
string

The emoji or icon representing the workspace.

Example:

"🚀"

settings
object

General settings for the workspace.