Skip to main content
GET
Search 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

filter
string | null

JSON-encoded filter string for structured search. Supported fields: name, id, environmentId, cluster_fqn. Supported operators: STRING_CONTAINS, STRING_STARTS_WITH, STRING_ENDS_WITH, EQUAL, IN, NOT_IN, IS_NULL.

Example:

"[{\"type\":\"name\",\"operator\":\"STRING_CONTAINS\",\"value\":\"prod\"}]"

includeCluster
boolean | null

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

Response

200 - application/json

Paginated workspaces matching the filter.

data
Workspace · object[]
required

List of workspaces matching the query criteria.

pagination
Pagination · object
required

Pagination metadata.