Skip to main content
GET
Get Workspace

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Alternatively, you can authenticate with a personal access token (PAT) by sending Authorization: Basic base64(email:PAT).

Scopes

management:workspaces:read

Read access to workspace resources.

Path Parameters

id
string<uuid>
required

Workspace identifier (UUID).

Response

OK

id
string<uuid>

Workspace identifier.

name
string

Workspace display name.

description
string | null

Purpose or team the workspace serves.

external_id
string | null

Caller-defined identifier used for idempotency.

is_default
boolean

true for the default workspace that is created automatically for the account. Exactly one workspace per account is the default. The system assigns this value, and you cannot set it.

member_count
integer

Number of members in the workspace.

connection_count
integer

Number of connections in the workspace.

created_at
string<date-time>

ISO 8601 UTC.

created_by
string<uuid>

The user who created the workspace.

members
object[]

Summary of up to 10 direct members, sorted by added_at descending. Group-derived members are not included.

connections
object[]

Summary of up to 10 connections, sorted by created_at descending.

Last modified on November 12, 2026