List workspaces

View as Markdown
**Attention**: This endpoint will return only paginated responses starting June 2, 2026. To start returning paginated responses before that date, include the query parameter `limit` in your request. This endpoint returns a list of all workspaces. You can use pagination and optionally filter by name to manage large sets of data. See [Manage Workspaces](/docs/manage-workspaces) for more details about workspaces in Sigma. ### Usage notes - **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 - **Pagination**: Use the `page` and `limit` parameters to control the size and segment of the workspace list returned. - **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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

pagestringOptional
Use to specify further pages using the string returned in the nextPage portion of the response.
limitdoubleOptional

Number of results to return per page, with a maximum of 1,000 per request. Use the page option in subsequent requests to retrieve the next set of results.

namestringOptional

Filter workspaces by name (substring match, case-insensitive).

exactNamestringOptional

Filter workspaces by exact name match (case-insensitive, like name). When set, this takes precedence over name and uses an indexed equality lookup instead of a substring search.

Response

The response body.
Single pagelist of objects
OR
Paginated resultsobject