ANanyreach
Agents

List Agent Ids

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

get/core/agents/ids

Request

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

Query parameters

offsetinteger
limitinteger

1-1000.

searchstring nullable

Matches the name, the company name, or phone number digits.

namestring nullable

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

sortstring nullable

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

dirstring nullable

asc or desc. Defaults to desc.

labelsstring 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"]}.

deployedboolean nullable
channelsstring nullable

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

created_bystring nullable
modified_bystring nullable
created_afterstring date-time nullable
created_beforestring date-time nullable
updated_afterstring date-time nullable
updated_beforestring date-time nullable
last_activity_afterstring date-time nullable
last_activity_beforestring date-time nullable
activeboolean nullable
is_demoboolean nullable
metadatastring nullable

JSON object the agent's metadata must contain.

Headers

x-anyreach-orgstring nullable

Organization ID for user PATs (pat_ prefix tokens)

Response

Successful Response

idsstring[] required
totalinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.