Skip to main content
GET
List workspaces

Authorizations

API-KEY
string
header
required

Query Parameters

page
integer
default:1

Page number (1-indexed).

Required range: x >= 1
page_size
integer
default:25

Number of items per page.

Required range: 1 <= x <= 100
filter[type]
enum<string>

Filter workspaces by type.

Available options:
playground,
branded
filter[state]
enum<string>

Filter workspaces by state.

Available options:
inactive,
processing,
ready_for_activation,
active,
failed,
disabled
sort
enum<string>

Field to sort by.

Available options:
inserted_at,
updated_at,
name
order
enum<string>

Sort direction.

Available options:
asc,
desc

Response

Paginated list of workspaces

data
WorkspaceSummary · object[]
required
meta
ListMeta · object
required