v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB

Calls

List calls of a lead

Returns call records attached to the given lead, with pagination metadata.

Notes:

leadId is required and must be > 0; otherwise 404 LEAD_NOT_FOUND.
Caller must have manage permission on the lead; otherwise 400 PERMISSION_DENIED.
total in _metadata reflects the full result size before pagination.

get/v1.0/calls

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

Zero-based index of the first entry to return.

leadIdinteger required

ID of the lead whose calls to return.

Headers

Authorizationstring required

Bearer [access_token]

Response

Page of call records with pagination metadata.

Example response

{
  "get_metadata": {
    "collection": "note",
    "limit": 10,
    "total": 50
  },
  "calls": [
    {
      "id": 563172647619608,
      "dialerCallRecordId": 400000012345,
      "userId": 100234,
      "userPhoneNumber": "+14155550100",
      "leadId": 100001,
      "leadPhoneNumber": "+14155550199",
      "direction": "Outbound",
      "status": "Completed",
      "startTime": "2026-04-22 10:15:00",
      "endTime": "2026-04-22 10:18:45",
      "duration": 225,
      "callingOutcome": "Talked",
      "rateScore": 4,
      "recordingSwitch": true,
      "showUserNumber": "+14155550100",
      "createTime": "2026-04-22 10:15:00",
      "updateTime": "2026-04-22 10:18:45",
      "note": "Discussed pre-approval timeline.",
      "price": 0.02,
      "agentId": 100234,
      "elapsedTime": "00:08"
    }
  ]
}