Skip to main content
GET
List Calls

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Path Parameters

campaign_id
string
required

Campaign configuration ID

Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

Query Parameters

status
string | null

Call status

search
string | null

Search keywords

outcomes
string[] | null

Outcome values to filter by

tags
string[] | null

Filter by tags (format: key:value)

groupId
string | null

Filter by group ID

is_deleted
boolean
default:false

When true, return only soft-deleted calls

size
integer
default:300

Number of items per page

Required range: x >= 1
page
integer
default:1

Page number

Required range: x >= 1
start
string<date-time> | null

Filter by start time (ISO 8601 format)

end
string<date-time> | null

Filter by end time (ISO 8601 format)

Response

Paginated list of call records

message
string
required

Result description

Example:

"Calls fetched successfully."

data
CampaignCallResponse · object[]
required

Paginated list of call record objects

totalCount
integer
required

Total number of calls matching the applied filters

page
integer
required

Current page number (1-indexed)

size
integer
required

Number of items returned on this page