Skip to main content
GET
List Workspaces
To list multiple Workspaces, string together the workspaceIds parameter. For example, workspaces?workspaceIds=workspaceId1&workspaceIds=workspaceId2.

Authorizations

Authorization
string
header
required

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

Path Parameters

organizationId
string
required

The ID of the Organization to list Workspaces for.

Query Parameters

workspaceIds
string[]

A list of IDs for specific Workspaces to list. The API will list information only for Workspaces which have been specified in this list.

names
string[]

A list of names for specific Workspaces to filter by. The API will list information only for Workspaces which have been specified in this list.

offset
integer
default:0

The number of results to skip before returning values.

Required range: x >= 0
limit
integer
default:20

The maximum number of results to return.

Required range: 0 <= x <= 1000
sorts
enum<string>[]

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

Available options:
name:asc,
name:desc,
createdAt:asc,
createdAt:desc,
updatedAt:asc,
updatedAt:desc

Response

OK

limit
integer
required

The maximum number of workspaces that can be retrieved per page.

Example:

0

offset
integer
required

The offset for the current page of workspaces in the complete result.

Example:

0

totalCount
integer
required

The total number of Workspaces in the paginated result.

Example:

0

workspaces
object[]
required

An array of Workspace objects representing a list of workspaces.