---
title: "List agents"
method: GET
path: "/v2/workbookAgents"
tags: ["workbookAgents"]
---

# List agents

`GET /v2/workbookAgents`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/workbookAgents`
- Auth: HTTP bearer

List the Sigma agents that you can edit across every workbook in the organization. An agent is returned when you own the workbook that defines it, or were granted **Can edit** access to it. Agents in workbooks that you can only view or explore are not included. Use the returned **agentId** and **workbookId** to [run a Sigma agent](https://help.sigmacomputing.com/reference/run-agent). To list agents defined in a single workbook instead, use [List agents in a workbook](https://help.sigmacomputing.com/reference/list-agents-in-workbook). 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).

## Query parameters

- `pageToken` string
- `pageSize` integer

## Response `200`

The response body.

- WorkbookAgentsListWorkbookAgentsResponse200
  - `entries` V2WorkbookAgentsGetResponsesContentApplicationJsonSchemaEntriesItems[], required: Array of results returned by the endpoint
    - `agentId` string, required: Unique identifier of the agent within a workbook.
    - `workbookId` string, required: Unique identifier of the workbook.
    - `agentName` string, nullable, required: Display name of the agent.
    - `agentDescription` string, nullable, required: Description of the agent.
  - `nextPageToken` string: 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.**

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)