Skip to navigation

API · Workspace · List the teamspaces the current user belongs to

View as Markdown

List the teamspaces (Spaces) the current user is a member of, within the token’s workspace. Use this to resolve a teamspace before scoping other calls: each returned id (integer) is the value you pass as the Space header (or --space / space_id) to narrow a request to that teamspace.

The token stays bound to its one workspace — this does not switch workspaces, it only lists the sub-spaces you can scope into. Supports ?search=<name> to filter by teamspace name and ?expand=settings.

Each item: {id (int), name, slug}.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

searchstringOptional

Filter teamspaces by name (substring match).

expandstringOptional

Comma-separated fields to expand inline (e.g. settings).

pageintegerOptional

1-based page number.

page_sizeintegerOptional
Results per page.

Response

Paginated list of the user's teamspaces.

Errors

401
Unauthorized Error