Skip to main content
GET
List workspaces

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer | null
default:100

Number of items per page

Required range: 1 <= x <= 1000
Example:

10

offset
integer | null
default:0

Number of items to skip

Required range: x >= 0
Example:

0

clusterId
string | null

System-generated cluster ID to filter by.

Example:

"jqfwg345gi25n5ju2yz5iz6m"

name
string | null

Filter workspaces by exact name match.

fqn
string | null

Human-readable Fully Qualified Name to filter by.

includeCluster
boolean | null

When true, each workspace in the response includes summary information about its cluster.

attributes
string[] | null

Comma-separated list of attributes to return (e.g. id,name). When provided, only the specified fields are fetched. id is always included.

Response

200 - application/json

Paginated list of workspaces the caller has access to.

data
Workspace · object[]
required

List of workspaces matching the query criteria.

pagination
Pagination · object
required

Pagination metadata.