ANanyreach
Agents

List Agents

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.

get/core/agents

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

idsstring nullable

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

offsetinteger nullable

Rows to skip. Not combinable with cursor.

limitinteger 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.

cursorstring nullable

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

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

idstring required
namestring required
descriptionstring required
activeboolean required
is_demoboolean required
metadataobject nullable
created_atstring date-time required
updated_atstring date-time required
created_bystring nullable
modified_bystring nullable
labelsobject
has_published_versionboolean required
published_versioninteger nullable
total_conversationsinteger
total_durationinteger nullable
average_durationnumber nullable
last_conversation_datestring date-time nullable
widget_countinteger
today_conversationsinteger
daily_conversation_countsinteger[]
latest_versionobject nullable

Changes

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