List Do Not Call Lists

📘

Supported Regions and Base URLs

Scope

do-not-call-lists:manage

Body Response - Schema

200 (get the list of do not call lists)

List with the paginated samples

ParameterTypeDescriptionRequired
per_pageintegerthe number of items per pageyes
totalintegerthe total number of itemsno
countintegerthe number of items in the pageno
pageintegerthe number of the current pageyes
total_pagesintegerthe total number of pagesno
_linksobjectHAL API related links.

"_links" subdivides into:

1 - "next" (object)- link of the next page.
1.1 - "href" (string) - address of the resource.
Required.

2 - "last" (object)- link of the last page.
2.1 - "href" (string) - address of the resource.
Required.

3 - "prev" (object)- link of the previous page.
3.1 - "href" (string) - address of the resource.
Required.

4 - "self" (object)- link of the current page.
4.1 - "href" (string) - address of the resource.
Required.

5 - "first" (object)- link of the current page.
5.1 - "href" (string) - address of the resource.
Required.
no
_embeddedobject"_embedded" subdivides into:

1 - "do_not_call_lists" (array[object])- list of do not call lists paginated.

1.1 - "id" (string
)
- ID of the do not call list created.

1.2 - "name" (string) - do not call list name.

1.3 - "created_at" (string) - do not call list creation date.

1.4 - "updated_at" (string) - do not call list updated date.

1.5 - "status" (string) - status of validation process done on the do not call list CSV file.
Allowed values:
REJECTED,
VALIDATION_STARTED,
UPLOADED, ACCEPTED,
INCOMPLETE, CORRUPTED.

1.6 - "entries_count" (integer) - how many entries are present in the do not call list.

1.7 - "teams" (array[object]) - teams that this do not call list belongs to, if any.
1.7.1 - "id" (string) - The team ID of the do not call list.
1.7.2 - "name" (string) - The team name of the do not call list.
1.7.3 - "_links" (string)
1.7.3.1 - "self" (object)
1.7.3.1.1 - "href" (string)

1.8 - "account_id" (string) - account ID of do not call list.

1.9 - "_links" (object) 1.9.1 - "self" (object)
1.9.1.1 - "href" (string)

401 (unauthorized), 403 (forbidden)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)
Language
Click Try It! to start a request and see the response here!