---
title: "List Agents"
method: GET
path: "/core/agents"
tags: ["Agents"]
---

# List Agents

`GET /core/agents`

## Request

- Base URL: `https://api.anyreach.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.anyreach.ai/core/agents`
- Auth: HTTP bearer

List agents.

`offset`, or any of sort, dir, search, labels, deployed, channels,
created_by, modified_by or last_activity_after/before, pages
api.agents_index: it searches name, company name and phone number,
filters by labels and the other query parameters, and sets
X-Total-Count on the first page (offset 0). Its page size defaults to
100. Otherwise, and whenever `cursor` or `ids` is given, it is the
original listing, which returns every matching agent when no limit is
given.

## Query parameters

- `ids` string, nullable: Comma-separated agent ids, at most 50. Bypasses paging.
- `offset` integer, nullable: Rows to skip. Not combinable with cursor.
- `limit` integer, nullable: Page size, 1-1000. Defaults to 100 whenever offset, sort, search or a newer filter is given. The original listing, selected by none of those or by cursor or ids, returns every matching agent when no limit is given.
- `cursor` string, nullable: Legacy created_at cursor. Selects the original listing, which ignores sort, offset and the newer filters.
- `search` string, nullable: Matches the name, the company name, or phone number digits.
- `name` string, nullable: Cursor or ids mode: name contains this. Otherwise an alias of search, used when search is absent.
- `sort` string, nullable: One of name, created_at, updated_at, created_by, modified_by, total_conversations, last_activity, deployed or label:<key>. Defaults to created_at.
- `dir` string, nullable: asc or desc. Defaults to desc.
- `labels` string, nullable: JSON object mapping a label key to a value, a list of values (any of them) or null (not set), e.g. {"industry": ["Telecom"]}.
- `deployed` boolean, nullable
- `channels` string, nullable: Comma-separated subset of voice, chat, demo. Matches agents with all of them.
- `created_by` string, nullable
- `modified_by` string, nullable
- `created_after` string, date-time, nullable
- `created_before` string, date-time, nullable
- `updated_after` string, date-time, nullable
- `updated_before` string, date-time, nullable
- `last_activity_after` string, date-time, nullable
- `last_activity_before` string, date-time, nullable
- `active` boolean, nullable
- `is_demo` boolean, nullable
- `metadata` string, nullable: JSON object the agent's metadata must contain.

## Headers

- `x-anyreach-org` string, nullable: Organization ID for user PATs (pat_ prefix tokens)

## Response `200`

Successful Response

- AgentResponse[]
  - `id` string, required
  - `name` string, required
  - `description` string, required
  - `active` boolean, required
  - `is_demo` boolean, required
  - `metadata` object, nullable
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `created_by` string, nullable
  - `modified_by` string, nullable
  - `labels` object
  - `versions` SimpleAgentVersionResponse[], required
    - `id` string, required
    - `version` integer, required
    - `published` boolean, required
    - `created_by` string, nullable
    - `modified_by` string, nullable
  - `has_published_version` boolean, required
  - `published_version` integer, nullable
  - `phone_numbers` SimplePhoneNumberResponse[], required
    - `phone_number` string, required
    - `agent_version_id` string, required
    - `version` integer, required
    - `direction` string, nullable
  - `widgets` SimpleWebWidgetResponse[]
    - `id` string, required
    - `agent_version_id` string, required
    - `published` boolean, required
  - `sip_endpoint` AgentSipEndpointResponse
    - `uri` string, required
    - `deployed` boolean, required
  - `total_conversations` integer
  - `total_duration` integer, nullable
  - `average_duration` number, nullable
  - `last_conversation_date` string, date-time, nullable
  - `widget_count` integer
  - `today_conversations` integer
  - `daily_conversation_counts` integer[]
  - `latest_version` object, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/anyreach/apis/anyreach-api.md) - [All operations](https://skmtc.dev/anyreach/apis/anyreach-api/llms.txt) - [OpenAPI document](https://skmtc.dev/anyreach/apis/anyreach-api/revisions/2eddf40c8c93?raw)