Skip to main content
GET
/
v2
/
customers
/
{id}
/
calls
Get paginated customer calls
curl --request GET \
  --url https://api.carecycle.ai/v2/customers/{id}/calls \
  --header 'x-api-key: <api-key>'
{
  "itemsTotal": 123,
  "currentPage": 123,
  "nextPage": 123,
  "prevPage": 123,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "disposition": "<string>",
      "callerId": "<string>",
      "twilioSid": "<string>",
      "service": "vapi",
      "testFlag": true,
      "direction": "inbound",
      "recordingUrl": "<string>",
      "recordingId": "<string>",
      "stereoRecordingUrl": "<string>",
      "assistantType": "<string>",
      "successEvaluation": "<string>",
      "summary": "<string>",
      "transcript": "<string>",
      "durationMs": 0,
      "createdAt": "<string>",
      "mainRecordingUrl": "<string>",
      "isTestNumber": true,
      "sourceName": "<string>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

API key required for authentication.

Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.

Path Parameters

id
string<uuid>
required

Customer ID

Query Parameters

page
number
default:1

GET /v2/customers/:id/calls Parameter

Required range: x >= 1
perPage
number
default:50

GET /v2/customers/:id/calls Parameter

Required range: 1 <= x <= 100
sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
disposition,
duration
sortDirection
enum<string>
default:desc

Sort direction

Available options:
asc,
desc

Response

GET /v2/customers/:id/calls Positive response

itemsTotal
number
required
currentPage
number
required
nextPage
number | null
required
prevPage
number | null
required
items
object[]
required

List of call records for the customer