## List

`$ boltz-api admin:workspaces list`

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

List workspaces

### Parameters

- `--after-id: optional string`

  Return results after this ID

- `--before-id: optional string`

  Return results before this ID

- `--limit: optional number`

  Max items to return

### Returns

- `ListWorkspacesResponse: object { data, first_id, has_more, last_id }`

  - `data: array of object { id, archived_at, created_at, 4 more }`

    - `id: string`

      Workspace ID

    - `archived_at: string`

    - `created_at: string`

    - `data_retention: object { unit, value }`

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

      - `unit: "hours" or "days"`

        Time unit for retention duration

        - `"hours"`

        - `"days"`

      - `value: number`

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

    - `is_default: boolean`

      Whether this is the default workspace

    - `name: string`

      Workspace name

    - `updated_at: string`

  - `first_id: string`

    ID of the first item. Use as before_id for the previous page.

  - `has_more: boolean`

  - `last_id: string`

    ID of the last item. Use as after_id for the next page.

### Example

```cli
boltz-api admin:workspaces list
```