Skip to main content
GET
List agents
Use agent_code as agent_id in call and session requests. For the next page, use pagination.nextOffset while pagination.hasMore is true.

Authorizations

Authorization
string
header
required

API key in the format: Bearer YOUR_KARTA_API_KEY.

Headers

X-Request-ID
string

Optional request-tracing identifier.

Query Parameters

limit
integer
default:20

Maximum number of items to return.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of items to skip.

Required range: x >= 0
status
enum<string>

Filter by agent status.

Available options:
live,
archive
type
enum<string>

Filter by agent type.

Available options:
chat,
voice,
onboarding,
audit
q
string

Search by agent name (case-insensitive).

Maximum string length: 100
sort
enum<string>
default:-created_at

Sort order; a leading minus means descending.

Available options:
created_at,
-created_at,
updated_at,
-updated_at,
name,
-name

Response

Successful response.

data
object[]
pagination
object