Skip to main content
GET
/
api
/
v1
/
call-logs
cURL
curl --request GET \
  --url https://app.callx.io/api/v1/call-logs \
  --header 'Authorization: Bearer <token>'
[
  {
    "callSid": "<string>",
    "assistantId": "<string>",
    "userId": "<string>",
    "streamSid": "<string>",
    "accountSid": "<string>",
    "caller": "<string>",
    "phoneNumber": "<string>",
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "callerCountry": "<string>",
    "costInCents": 123,
    "endedReason": "<string>",
    "hangupReason": "<string>",
    "duration": 123,
    "messages": [
      {}
    ],
    "tokenUsage": [
      {}
    ],
    "callType": "<string>",
    "summary": "<string>",
    "customeAssistant": {},
    "callTime": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
startDate
string<date>

The start date for filtering results (YYYY-MM-DD format)

​
endDate
string<date>

The end date for filtering results (YYYY-MM-DD format)

​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
pageSize
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
​
search
string

Search query to filter results

​
type
enum<string>

Type of interaction to filter by

Available options:
inbound,
outbound
​
assistant
string

Assistant ID to filter results by specific assistant

​
endedReason
enum<string>

Reason for how the interaction ended

Available options:
call-in-progress,
user-hung-up,
silence-timed-out,
error,
exceeded-max-duration,
assistant-ended-call,
assistant-low-balance,
assistant-not-found,
assistant-forwarded-error,
no-answer,
busy,
failed

Response

Call logs retrieved successfully.

​
callSid
string
required

Unique identifier for the call session

​
assistantId
string
required

MongoDB ObjectId reference to the assistant

​
userId
string
required

Identifier for the user associated with the call

​
streamSid
string
required

Identifier for the call stream

​
accountSid
string
required

Account identifier associated with the call

​
caller
string
required

Phone number or identifier of the caller

​
phoneNumber
string
required

Phone number used for the call

​
startTime
string<date-time>
required

Timestamp when the call started

​
endTime
string<date-time>
required

Timestamp when the call ended

​
callerCountry
string

Country code of the caller

​
costInCents
number

Total cost of the call in cents

​
endedReason
string

Reason why the call ended

​
hangupReason
string

Specific reason for call hangup

​
duration
number

Duration of the call in seconds

​
messages
object[]
​
tokenUsage
object[]
​
callType
string

Type or category of the call

​
summary
string

Summary or notes about the call

​
customeAssistant
object

Custom assistant configuration or details

​
callTime
string

Formatted or processed call time information