Skip to main content
GET
Pick an agent for a call

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer kb_live_…. A workspace key starts kb_; a personal key starts kbp_ and acts as its owner.

Headers

Kallabot-Version
enum<string>

The API version to answer as, a date (YYYY-MM-DD). Leave it out for the current version (2026-11-07). An unknown version is refused with 400 unsupported_api_version.

Available options:
2026-11-07
Example:

"2026-11-07"

Query Parameters

can
enum<string>
default:dial
Available options:
dial,
answer
search
string | null
Maximum string length: 100
limit
integer | null
Required range: 1 <= x <= 100
cursor
string | null
Maximum string length: 512

Response

Successful Response

Live agents that can make (or take) a call, A-Z.

data
PickedAgent · object[]
required

The items on this page, in the list's order.

has_more
boolean
required

True when another page follows this one.

total
integer
required

Every agent matching the filter, across all pages.

unpublished
integer
required

Your agents not published yet (first page without a search only; 0 otherwise).

next_cursor
string | null

Pass as cursor to get the next page. Null on the last page. Opaque: don't parse it.