List Campaigns

get

https://api.talkdeskapp.com/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

fields

string

length ≤ 2083

Allows to request the sub entities of the campaign

dialing_mode_configuration -> Return the campaign's dialing mode configuration.
dialing_strategy -> Return the campaign's dialing strategy.
teams -> Return the campaign's teams information.

page

integer

≥ 1

Defaults to 1

per_page

integer

1 to 100

Defaults to 50

name

string

length ≤ 35

Filter by campaign name

user_id

string

length ≤ 36

Filter by user id.

team_id

string

Filter Campaigns by team id.

do_no_call_list_id

string

length ≤ 36

Filter by 'Do Not Call List Id'.

record_list_id

string

length ≤ 36

Filter by 'Record list id'.

string

length ≤ 35

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

string

enum

length ≤ 35

Defaults to created_at:desc

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

dialing_mode

string

enum

length ≤ 35

Allows filtering by dialing_mode

Allowed:

status

string

enum

length ≤ 35

Allows filtering by status

Allowed:

action_required

boolean

Allows filtering by action_required

priority

integer

1 to 10

Allows filtering by priority

created_at_from

date-time

length ≤ 35

Allows filtering by created_at, the oldest date.

created_at_to

date-time

length ≤ 35

Allows filtering by created_at, the lastest date.

Responses

200successful operation

400Errors were found in the submitted data.

401Unauthorized

403Forbidden