Sign in

v1

latestOpenAPI 3.0.22026-07-2441902.6 MB
Campaign Management API

List Campaigns

Returns a paginated list of campaigns for the account. Use this endpoint to retrieve all campaigns with optional filtering by name, status, dialing mode, and other criteria. Supports sorting and searching with partial matches.

get/campaigns

Query parameters

fieldsstring

Allows to request the sub entities of the campaign<br/><br/> <ul> <li>dialing_mode_configuration -> Return the campaign's dialing mode configuration.</li> <li>dialing_strategy -> Return the campaign's dialing strategy.</li> <li>teams -> Return the campaign's teams information.</li> </ul>

pageinteger
per_pageinteger
namestring

Filter by campaign name

user_idstring

Filter by user id.

team_idstring

Filter Campaigns by team id.

do_no_call_list_idstring

Filter by 'Do Not Call List Id'.

record_list_idstring

Filter by 'Record list id'.

searchstring

Search campaigns with total and partial matches of a given search string, this will be case insensitive and accent/diacritics insensitive.

The search will be done on the following fields: name

order_by'created_at' | 'created_at:asc' | 'created_at:desc' | 'name' | 'name:asc' | 'name:desc' | 'dialing_mode' | 'dialing_mode:asc' | 'dialing_mode:desc' | 'priority' | 'priority:asc' | 'priority:desc'

Order campaigns by name, dialing mode or created at in an ascending or descending order.

dialing_mode'PREDICTIVE' | 'PREVIEW'

Allows filtering by dialing_mode

status'incomplete' | 'ready' | 'running' | 'paused'

Allows filtering by status

action_requiredboolean

Allows filtering by action_required

priorityinteger

Allows filtering by priority

created_at_fromstring date-time

Allows filtering by created_at, the oldest date.

created_at_tostring date-time

Allows filtering by created_at, the lastest date.

Response

successful operation