Skip to main content
POST
/
v2
/
workspaces
/
list
Get All Workspaces
curl --request POST \
  --url http://localhost:8000/v2/workspaces/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filters": {}
}'
{
  "items": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "metadata": {},
      "configuration": {}
    }
  ],
  "page": 2,
  "size": 2,
  "total": 1,
  "pages": 1
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Body

application/json

Filtering and pagination options for the workspaces list

​
filters
Filters · object

Response

Successful Response

​
items
Workspace · object[]
required
​
page
integer | null
required
Required range: x >= 1
​
size
integer | null
required
Required range: x >= 1
​
total
integer | null
Required range: x >= 0
​
pages
integer | null
Required range: x >= 0