> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List agents

> A list of agents

### Query parameters

<ParamField query="limit" type="integer" />

<ParamField query="offset" type="integer" />

### Response

`object`

<ResponseField name="object" type="string" />

<ResponseField name="data" type="Agent[]">
  <Expandable title="Agent">
    <ResponseField name="object" type="string" />

    <ResponseField name="id" type="string" />

    <ResponseField name="name" type="string,null" />

    <ResponseField name="type" type="string,null" />

    <ResponseField name="description" type="string,null" />

    <ResponseField name="activated" type="boolean" />

    <ResponseField name="goal" type="string,null" />

    <ResponseField name="role" type="string,null" />

    <ResponseField name="updated_at" type="string,null" />

    <ResponseField name="instructions" type="string,null">
      Present on single-agent reads and writes only.
    </ResponseField>

    <ResponseField name="settings" type="AgentSettingsOut">
      <Expandable title="AgentSettingsOut">
        <ResponseField name="object" type="string" />

        <ResponseField name="configured" type="boolean">
          False when no settings row exists yet (fields are all null).
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="has_more" type="boolean" />

<ResponseField name="next_cursor" type="string">
  Keyset cursor for the next page — present only on cursor-capable lists with more rows.
</ResponseField>

### Status codes

| Code  | Meaning                               |
| ----- | ------------------------------------- |
| `200` | A list of agents                      |
| `401` | Missing, invalid, or expired API key. |
| `403` | The key lacks a required scope.       |
| `429` | Rate limit exceeded.                  |

### Access

|                |                         |
| -------------- | ----------------------- |
| Required scope | `agents:read`           |
| Rate limit     | 120 requests per minute |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://response.stateset.com/api/v1/agents' \
    --header 'Authorization: Bearer YOUR_API_KEY'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "object": "list",
    "data": [
      {
        "object": "string",
        "id": "string",
        "name": null,
        "type": null,
        "description": null,
        "activated": true,
        "goal": null,
        "role": null,
        "updated_at": null,
        "instructions": null,
        "settings": {
          "object": null,
          "configured": null
        }
      }
    ],
    "has_more": true,
    "next_cursor": "string"
  }
  ```
</ResponseExample>