Sigma REST APIWorkbooksagents

List agents in a workbook (Beta)

View as Markdown

List the Sigma agents defined in a workbook.

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired
Unique identifier of the workbook to list agents from.

Query parameters

versionTagNamestringOptional
Name of the version tag whose workbook version to list agents from. Omit to list agents from the latest published version.

Response

The response body.
entrieslist of objects
Array of results returned by the endpoint
nextPageTokenstringOptional

A string that can be passed to the pageToken parameter in the next request to fetch the next page of results. Not present in the last page of results. Must be treated as an opaque string.