Skip to main content
GET
List calls

Authorizations

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Query Parameters

limit
integer
default:20
Required range: x <= 100
offset
integer
default:0
agent_id
string<uuid>

Filter by agent

status
string

Filter by call status (e.g. completed, failed, in_progress, no_answer, dnc_blocked)

direction
enum<string>
Available options:
inbound,
outbound,
web_call
callee
string

Filter by callee (destination) phone number in E.164. Useful for counting prior attempts to a specific lead — e.g. retry-throttle logic: ?agent_id=X&callee=+972Y&from=TODAY then read data.length directly.

caller
string

Filter by caller (source) phone number in E.164.

from
string<date-time>

Return calls created on or after this timestamp

to
string<date-time>

Return calls created on or before this timestamp

Response

200 - application/json

List of calls

data
object[]
pagination
object