Skip to main content
GET
List your workspaces

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization-code flow with PKCE.

FlowAuthorization Code
Authorization URL
https://auth.streamloop.app/api/auth/oauth2/authorize
Token URL
https://auth.streamloop.app/api/auth/oauth2/token
Scopes1
streamloop:read
Read streams, destinations, playlists, and billing status

Headers

X-Workspace-Id
string

Workspace this request operates in — the workspace id (wksp_…) or the organization id, from GET /workspaces. Required with an API key, which carries no workspace (400 WORKSPACE_REQUIRED without it). With an OAuth token it defaults to the workspace the token was issued for. Responds 403 WORKSPACE_FORBIDDEN when the caller is not a current member, rather than falling back to another workspace.

Response

Successful response.

active
boolean
required

True for the workspace THIS request already resolves to, i.e. the default when no workspaceId is passed.

id
string
required

Workspace id (wksp_…). Send it as X-Workspace-Id or a workspaceId argument.

name
string
required
personal
boolean
required

True for the account's own single-owner workspace, which cannot be deleted while the account exists.

role
enum<string>
required

The authenticated account's role in this workspace. Billing operations require owner or admin.

Available options:
owner,
admin,
member
slug
string
required
identityId
string | null

Organization id; accepted wherever the workspace id is.