---
title: "List workspaces (Paginated)"
method: GET
path: "/v2.1/workspaces"
tags: ["Workspaces"]
---

# List workspaces (Paginated)

`GET /v2.1/workspaces`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2.1/workspaces`
- Auth: HTTP bearer

**Attention:** This API endpoint uses pagination by default.

  This endpoint returns all workspaces. See [Manage Workspaces](/docs/manage-workspaces) for more details about workspaces in Sigma.

  ### Usage notes
  - **Pagination**: Use the `page` and `limit` parameters to control the size and segment of the workspace list returned.
  - **Filtering by name**: Optionally, use the `name` parameter to filter workspaces by a case-insensitive substring match.
  - **Filtering by exact name**: Optionally, use the `exactName` parameter to filter workspaces by an exact name match (also case-insensitive). When provided, `exactName` takes precedence over `name` and uses an indexed equality lookup, which is significantly faster than substring search.

  ### Usage scenarios
  - **User interface display**: Populate a user interface with a list of all available workspaces, using pagination to efficiently load data and filtering to quickly find specific workspaces.
  - **Administrative overview**: Provide system administrators with an overview of all workspaces for management and monitoring purposes, with the ability to browse through pages and search by name.

  ### Best practices
  - Use caching to reduce load times and server demand when frequently accessing workspace lists.
  - Regularly update and synchronize workspace lists to ensure that displayed information is current and accurate.

## Query parameters

- `page` string
- `limit` number, double
- `name` string
- `exactName` string

## Response `200`

The response body.

- WorkspacesV21ListWorkspacesResponse200
  - `entries` V21WorkspacesGetResponsesContentApplicationJsonSchemaEntriesItems[], required: Array of results returned by the endpoint
    - `workspaceId` string, required
    - `workspaceUrlId` string, required: Base62-encoded identifier used in Sigma workspace URLs.
    - `name` string, required
    - `createdBy` string, required
    - `updatedBy` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `nextPage` string, nullable, required: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`.
  - `total` number, double: Total number of results. Useful to determine if there is a need to paginate.
  - `hasMore` boolean: **[Deprecated]** Indicates whether more results are available.

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)