Skip to main content
GET
/
calls
List calls
curl --request GET \
  --url https://api.goyappr.com/calls \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "from": "<string>",
      "to": "<string>",
      "direction": "<string>",
      "status": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "duration_seconds": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "disconnect_reason": "<string>",
      "transferred_at": "2023-11-07T05:31:56Z",
      "transfer_target": "<string>",
      "recording_url": "<string>",
      "tool_calls_count": 123,
      "flow_steps_count": 123,
      "flow_tool_fires_count": 123,
      "disposition": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "label": "<string>",
        "color": "#22c55e",
        "position": 123,
        "is_protected": true,
        "created_at": "2023-11-07T05:31:56Z"
      },
      "lead": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "phone_number": "+972501234567",
        "name": "<string>",
        "email": "jsmith@example.com",
        "source": "api",
        "tags": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "description": "<string>",
            "color": "<string>",
            "sort_order": 123,
            "created_at": "2023-11-07T05:31:56Z"
          }
        ],
        "long_term_context": "<string>",
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "has_more": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.goyappr.com/llms.txt

Use this file to discover all available pages before exploring further.

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