List workspaces

admin.workspaces.list() -> SyncCursorPage[WorkspaceListResponse]

GET/compute/v1/admin/workspaces

List workspaces

ParametersExpand Collapse

after_id: Optional[str]

Return results after this ID

before_id: Optional[str]

Return results before this ID

limit: Optional[int]

Max items to return

minimum1

maximum100

ReturnsExpand Collapse

class WorkspaceListResponse: …

id: str

Workspace ID

archived_at: Optional[datetime]

formatdate-time

created_at: datetime

formatdate-time

data_retention: DataRetention

How long result data is retained before automatic deletion. Defaults to 7 days if not specified. Maximum retention is 14 days (336 hours).

unit: Literal["hours", "days"]

Time unit for retention duration

Accepts one of the following:

"hours"

"days"

value: int

Duration value. Maximum retention is 14 days (or 336 hours).

minimum1

is_default: bool

Whether this is the default workspace

name: Optional[str]

Workspace name

updated_at: datetime

formatdate-time

List workspaces

import os
from boltz_api import Boltz

client = Boltz(
    api_key=os.environ.get("BOLTZ_API_KEY"),  # This is the default and can be omitted
)
page = client.admin.workspaces.list()
page = page.data[0]
print(page.id)

{
  "data": [
    {
      "id": "id",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "created_at": "2019-12-27T18:11:19.117Z",
      "data_retention": {
        "unit": "hours",
        "value": 1
      },
      "is_default": true,
      "name": "name",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

Returns Examples

{
  "data": [
    {
      "id": "id",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "created_at": "2019-12-27T18:11:19.117Z",
      "data_retention": {
        "unit": "hours",
        "value": 1
      },
      "is_default": true,
      "name": "name",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}