Agents

List agents

Lists your organization’s agents in one of two modes.

Sorted listing. Sending offset, or any of sort, dir, search, labels, deployed, channels, created_by, modified_by or last_activity_after/last_activity_before, sorts and filters on the server and pages by offset and limit (default 100, up to 1,000). The offset=0 page carries the total match count in the X-Total-Count header. Stop when a page returns fewer than limit agents.

Original listing. With only the original parameters, or with cursor or ids, the list is newest first and pages by cursor, as it always has. Without a limit it returns every matching agent.

See Labels and lists over the API.

GET

core

agents

List agents

curl --request GET \
  --url https://api.anyreach.ai/core/agents

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.anyreach.ai/core/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.anyreach.ai/core/agents"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.anyreach.ai/core/agents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Example",
    "description": "string",
    "active": false,
    "is_demo": false,
    "metadata": {},
    "created_at": "2026-01-15T09:30:00Z",
    "updated_at": "2026-01-15T09:30:00Z",
    "created_by": "user:3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "modified_by": "user:3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "labels": {},
    "versions": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "version": 1,
        "published": false,
        "created_by": null,
        "modified_by": null
      }
    ],
    "has_published_version": false,
    "published_version": 1,
    "phone_numbers": [
      {
        "phone_number": "+14155550123",
        "agent_version_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "version": 1,
        "direction": null
      }
    ],
    "widgets": [],
    "sip_endpoint": {
      "uri": "string",
      "deployed": false
    },
    "total_conversations": 0,
    "total_duration": 1,
    "average_duration": 1,
    "last_conversation_date": "2026-01-15T09:30:00Z",
    "widget_count": 0,
    "today_conversations": 0,
    "daily_conversation_counts": [],
    "latest_version": {}
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

x-anyreach-org

string | null

Organization ID for user PATs (pat_ prefix tokens)

Query Parameters

ids

string | null

Comma-separated agent ids, at most 50. Bypasses paging.

offset

integer | null

Rows to skip. Not combinable with cursor.

limit

integer | null

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 | null

Legacy created_at cursor. Selects the original listing, which ignores sort, offset and the newer filters.

string | null

Matches the agent name, the company name, or the digits of an assigned phone number (four or more). Matches the name, the company name, or phone number digits.

name

string | null

Cursor or ids mode: name contains this. Otherwise an alias of search, used when search is absent.

sort

string | null

One of name, created_at, updated_at, created_by, modified_by, total_conversations, last_activity, deployed or label:. Defaults to created_at.

dir

string | null

asc or desc. Defaults to desc.

labels

string | null

URL-encoded JSON object mapping a label key to a value, a list of values (any of them), or null (not set), such as {"industry": ["Healthcare"]}. 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 | null

channels

string | null

Comma-separated subset of voice, chat, demo. Matches agents with all of them.

created_by

string | null

modified_by

string | null

created_after

string<date-time> | null

created_before

string<date-time> | null

updated_after

string<date-time> | null

updated_before

string<date-time> | null

last_activity_after

string<date-time> | null

last_activity_before

string<date-time> | null

active

boolean | null

is_demo

boolean | null

metadata

string | null

JSON object the agent's metadata must contain.

Response

Successful Response

string

required

name

string

required

description

string

required

active

boolean

required

is_demo

boolean

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

versions

SimpleAgentVersionResponse · object[]

required

Show child attributes

has_published_version

boolean

required

phone_numbers

SimplePhoneNumberResponse · object[]

required

Show child attributes

metadata

Metadata · object | null

created_by

string | null

modified_by

string | null

labels

Labels · object

Show child attributes

published_version

integer | null

widgets

SimpleWebWidgetResponse · object[]

Show child attributes

sip_endpoint

AgentSipEndpointResponse · object | null

Show child attributes

total_conversations

integer

default:0

total_duration

integer | null

average_duration

number | null

last_conversation_date

string<date-time> | null

today_conversations

integer

default:0

daily_conversation_counts

integer[]

latest_version

Latest Version · object | null

List agents

curl --request GET \
  --url https://api.anyreach.ai/core/agents

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.anyreach.ai/core/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.anyreach.ai/core/agents"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.anyreach.ai/core/agents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Example",
    "description": "string",
    "active": false,
    "is_demo": false,
    "metadata": {},
    "created_at": "2026-01-15T09:30:00Z",
    "updated_at": "2026-01-15T09:30:00Z",
    "created_by": "user:3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "modified_by": "user:3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "labels": {},
    "versions": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "version": 1,
        "published": false,
        "created_by": null,
        "modified_by": null
      }
    ],
    "has_published_version": false,
    "published_version": 1,
    "phone_numbers": [
      {
        "phone_number": "+14155550123",
        "agent_version_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "version": 1,
        "direction": null
      }
    ],
    "widgets": [],
    "sip_endpoint": {
      "uri": "string",
      "deployed": false
    },
    "total_conversations": 0,
    "total_duration": 1,
    "average_duration": 1,
    "last_conversation_date": "2026-01-15T09:30:00Z",
    "widget_count": 0,
    "today_conversations": 0,
    "daily_conversation_counts": [],
    "latest_version": {}
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Get Started

Agents

Labels

Capability documents

Conversations

Conversation attachments

Conversation events

Knowledge bases

Knowledge base sources

Sources

Phone numbers

Trunks

Inbound routing

Agent assist

Human handoff

Email domains

Email addresses

Unsubscribes

Web widgets

Campaigns

Campaign contacts

Campaign configurations

Campaign stats

Custom data

Metrics

Evaluations

Evaluation runs

Workflows

Workflow triggers

Workflow executions

Workflow credentials

List agents

Headers

Query Parameters

Response