## List

`admin.workspaces.list(WorkspaceListParams**kwargs)  -> SyncCursorPage[WorkspaceListResponse]`

**get** `/compute/v1/admin/workspaces`

List workspaces

### Parameters

- `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

### Returns

- `class WorkspaceListResponse: …`

  - `id: str`

    Workspace ID

  - `archived_at: Optional[datetime]`

  - `created_at: datetime`

  - `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

      - `"hours"`

      - `"days"`

    - `value: int`

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

  - `is_default: bool`

    Whether this is the default workspace

  - `name: Optional[str]`

    Workspace name

  - `updated_at: datetime`

### Example

```python
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)
```