Skip to navigation
Sigma REST APIWorkspacesList workspaces

List workspaces (Paginated)

View as Markdown

Attention: This API endpoint uses pagination by default.

This endpoint returns all workspaces. See 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.

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.
entrieslist of objects
Array of results returned by the endpoint
nextPagestring or null

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.

totaldoubleOptional
Total number of results. Useful to determine if there is a need to paginate.
hasMorebooleanOptional

[Deprecated] Indicates whether more results are available.