v2

latestOpenAPI 3.1.02026-07-273779120.8 KB
Campaigns Calls
Campaign Calls

List Calls

Fetch a paginated list of call records for a campaign.

  • page / size: Pagination (default: page=1, size=50, max size=200).
  • start / end: ISO 8601 date range filter on call creation date.
  • status: Filter by call status (received, ready, queued, ringing, processing, ended, completed, failed).
  • search: Search term matched against phone number or other call fields.
  • outcomes: Repeat to filter by multiple outcomes: ?outcomes=voicemail&outcomes=no_answer.
  • tags: Repeat to filter by multiple tags: ?tags=region:west&tags=priority:high.
  • groupId: When provided, returns calls across all campaign runs in the group.
get/campaigns/v1/campaigns/{campaign_id}/calls/list

Path parameters

campaign_idstring required
Example:5eb7cf5a86d9755df3a6c593

Campaign configuration ID

Query parameters

statusstring nullable

Call status

Call status

searchstring nullable

Search keywords

Search keywords

outcomesstring[] nullable

Outcome values to filter by

Outcome values to filter by

tagsstring[] nullable

Filter by tags (format: key:value)

Filter by tags (format: key:value)

groupIdstring nullable

Filter by group ID

Filter by group ID

is_deletedboolean

When true, return only soft-deleted calls

When true, return only soft-deleted calls

sizeinteger

Number of items per page

Number of items per page

pageinteger

Page number

Page number

startstring date-time nullable

Filter by start time (ISO 8601 format)

Filter by start time (ISO 8601 format)

endstring date-time nullable

Filter by end time (ISO 8601 format)

Filter by end time (ISO 8601 format)

Response

Paginated list of call records

messagestring required

Result description

totalCountinteger required

Total number of calls matching the applied filters

pageinteger required

Current page number (1-indexed)

sizeinteger required

Number of items returned on this page

Example response

{
  "message": "Calls fetched successfully.",
  "data": [
    {
      "review": {
        "by": "5eb7cf5a86d9755df3a6c593"
      }
    }
  ]
}