List agents in a workbook | Sigma Documentation

List the Sigma agents defined in a workbook. Use the returned agentId and workbookId to run a Sigma agent. To list agents across every workbook in the organization instead of one workbook, use List agents. For a guide to calling Sigma agents from the API, see Call Sigma agents with the API.

Usage notes

Retrieve the workbookId by calling the /v2/workbooks endpoint.

List the Sigma agents defined in a workbook. Use the returned **agentId** and **workbookId** to [run a Sigma agent](https://help.sigmacomputing.com/reference/run-agent). To list agents across every workbook in the organization instead of one workbook, use [List agents](https://help.sigmacomputing.com/reference/list-workbook-agents). For a guide to calling Sigma agents from the API, see [Call Sigma agents with the API](https://help.sigmacomputing.com/docs/call-agents-with-the-api). ### Usage notes - Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.

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.