> This page is for version 0.11.
> For other versions, use one of these documentation indexes:
> - Latest (default): https://docs.nvidia.com/nemo-helix/latest/llms.txt
> - 0.11: https://docs.nvidia.com/nemo-helix/v0.11/llms.txt
> - 0.10: https://docs.nvidia.com/nemo-helix/v0.10/llms.txt
> - 0.9: https://docs.nvidia.com/nemo-helix/v0.9/llms.txt
> - 0.8: https://docs.nvidia.com/nemo-helix/v0.8/llms.txt
> - 0.7: https://docs.nvidia.com/nemo-helix/v0.7/llms.txt
> - 0.6: https://docs.nvidia.com/nemo-helix/v0.6/llms.txt
> - 0.5: https://docs.nvidia.com/nemo-helix/v0.5/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo-helix/llms.txt.

# List all workspaces

GET http://localhost:8080/apis/entities/v2/workspaces

List all workspaces with pagination.

Workspaces marked for deletion (non-null deletion_stage) are omitted so the
list matches GET/DELETE, which treat those workspaces as not found.

When authentication is enabled, only workspaces the principal has access to
are returned. Service principals and platform admins have access to all workspaces.

Query Parameters:
- page, page_size: Pagination
- sort: Sort field
- filter: Advanced filters (JSON, text, or bracket notation)

Example:
```
GET /apis/entities/v2/workspaces?sort=-created_at&page=1&page_size=10
```

Reference: https://docs.nvidia.com/nemo-helix/documentation/reference/api-reference/entity-store/list-workspaces-apis-entities-v-2-workspaces-get

## Request

### Query parameters

- `sort` (enum, optional, default: -created_at) — Sort field
  - Allowed values: `created_at`, `-created_at`, `updated_at`, `-updated_at`, `name`, `-name`
- `filter` (string, optional) — Query filter expression. Supports text and JSON syntaxes: * Text: name:"value" AND status>500 with operators : \~ > >= \< \<= IN NOT IN AND OR and negation prefix - * Object (JSON): \{"name":\{"$like":"value"}} with operators $eq, $like, $lt, $lte, $gt, $gte, $in, $nin, $and, $or, $not * Bracket notation: ?filter\[name]\[\$like]=value * Relationship traversal: ?filter\[relationship]\[\$exists]=true or ?filter\[relationship]\[field]=value
- `page` (integer, optional, default: 1) — Page number.
- `page_size` (integer, optional, default: 100) — Page size.

## Response

### 200

Successful Response

- `data` (list of Workspace, required)
- `pagination` (PaginationData, optional) — Pagination information.
- `sort` (string, optional) — The field on which the results are sorted.
- `filter` (map from string to any, optional) — Filtering information.

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### Workspace

Workspace schema for API responses.

- `id` (string, required) — System-generated UUID
- `name` (string, required) — Workspace name (user-provided)
- `created_at` (datetime, required) — Timestamp of workspace creation
- `updated_at` (datetime, required) — Timestamp of last workspace update
- `description` (string, optional) — Optional description
- `limits` (WorkspaceLimits, optional) — Optional per-workspace resource limits
- `created_by` (string, optional) — Principal id for workspace creator
- `updated_by` (string, optional) — Principal id for last workspace update

### PaginationData

- `page` (integer, required) — The current page number.
- `page_size` (integer, required) — The page size used for the query.
- `current_page_size` (integer, required) — The size for the current page.
- `total_pages` (integer, required) — The total number of pages.
- `total_results` (integer, required) — The total number of results.

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)
- `input` (any, optional)
- `ctx` (map from string to any, optional)

### WorkspaceLimits

Optional per-workspace resource limits. A field left unset means "use the platform default"; the consumer applies that default, it is never written back to the workspace record.

- `max_concurrent_jobs` (integer, optional) — Maximum number of jobs the workspace may have admitted concurrently. When unset, the Jobs service default applies.

### ValidationErrorLocItems

- string
- integer

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "string",
      "name": "string",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "description": "string",
      "limits": {
        "max_concurrent_jobs": 1
      },
      "created_by": "string",
      "updated_by": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "current_page_size": 1,
    "total_pages": 1,
    "total_results": 1
  },
  "sort": "string",
  "filter": {}
}
```

**SDK Code**

```python
import requests

url = "http://localhost:8080/apis/entities/v2/workspaces"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'http://localhost:8080/apis/entities/v2/workspaces';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```