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

# List Agent Ids

`GET /core/agents/ids`

## 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/ids`
- Auth: HTTP bearer

The ids of every agent matching the list's search and filters, in
list order, with the total. Select-all pages through this.

## Query parameters

- `offset` integer
- `limit` integer: 1-1000.
- `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

- IdsPage
  - `ids` string[], required
  - `total` integer, required

## 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)