Skip to navigation
Sigma REST APIWorkbooks

List workbooks

View as Markdown

This endpoint retrieves a list of all available workbooks.

Available workbooks include any workbooks in your My Documents folder and any workbooks you have access to.

Users with the Admin account type can optionally retrieve all workbooks in the organization.

Usage notes

This endpoint requires no parameters for basic requests, but supports query parameters for pagination and response limit.

Pagination

This endpoint supports pagination, which lets you retrieve large sets of data in manageable segments. The response includes pagination details as follows:

  • hasMore: A boolean value indicating whether there are more pages of data available beyond the current page.
  • total: The total number of entries available across all pages.
  • nextPage: An identifier or token that you can use in a subsequent request to retrieve the next page of data.

Example response for pagination

 {
   "hasMore": true,
   "total": 104,
   "nextPage": "50"
 }

To request additional pages, include the nextPage option in your next request as the value of the page option. Repeat this process until nextPage returns null, indicating that there are no more pages to return.

Usage scenarios

  • Workbook navigation: Allows users to easily navigate through their collection of workbooks and access the one they need.
  • Integration points: Useful for building integrations that need to present users with a list of their available workbooks, such as in custom applications using Sigma Embeds.

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.

excludeTagsbooleanOptional
skipPermissionCheckbooleanOptional
Only available to Sigma admins. Return all workbooks, including custom views, regardless of whether the user has access.
isArchivedbooleanOptional
Return archived workbooks.
excludeExplorationsbooleanOptional

When used with skipPermissionCheck, excludes custom views from the results, otherwise ignored.

includeTaggedSourceUrlIdbooleanOptional

When true, returns a URL to the source document for any version-tagged workbook deployed to a tenant organization.

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.