List Do Not Call Lists

get

https://api.talkdeskapp.com/do-not-call-lists

Returns a paginated list of Do Not Call Lists for the account.
Use this endpoint to retrieve all lists with optional filtering by name, status, team, and campaign.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

do-not-call-lists:manage

Query Params

name

string

Filter Do Not Call Lists by name

status

string

Filter Do Not Call Lists by status

team_id

string

Filter Do Not Call Lists by team id. team_id and team_ids are mutually exclusive.

team_ids

array of strings

Filter Do Not Call Lists by team ids. team_id and team_ids are mutually exclusive.

team_ids

campaign_ids

array of strings

Filter do not call Lists by campaign ids.

campaign_ids

fields

string

enum

Allows to request the sub entities of the do not call list.

teams -> Return the do not call list's teams information.

Allowed:

include_none_team

string

If include_none_team equals true, this parameter will also return do not call lists with no team.

page

integer

Number of the page listed

per_page

integer

Number of max items per page

created_at_from

string

Filter by Do Not Call Lists created_at

created_at_to

string

Filter by Do Not Call Lists created_at

updated_at_from

string

Filter by Do Not Call Lists updated_at

updated_at_to

string

Filter by Do Not Call Lists updated_at

order_by

string

Defaults to created_at:desc

Order by Do Not Call Lists for names, number of entries, created_at, updated_at

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/hal+json

Scope

200Get the list of do not call lists

401Unauthorized

403Forbidden