TAtalkdesk
Campaign Management API

List Entries

Returns a paginated list of entries from a Do Not Call List. Use this endpoint to retrieve all phone number entries with optional filtering and sorting.

get/do-not-call-lists/{id}/entries

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/do-not-call-lists/{id}/entries
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: do-not-call-lists:manage

Path parameters

idstring required

The identifier of the do not call list.

Query parameters

phone_numberstring

Filter Entries by phone number

pageinteger

number of the page listed

per_pageinteger

Number of max items per page

order_bystring
Example:expiration_date:desc,created_at:desc,updated_at:asc

Order by Entries for expiration date, created_at, updated_at

Response

Get a list of entries

per_pageinteger

The number of items per page

totalinteger

The total number of items.

countinteger

The number of items in the page

pageinteger

The number of the current page

total_pagesinteger

The total number of pages

Example response

{
  "page": 2,
  "total_pages": 3,
  "per_page": 1,
  "total": 3,
  "count": 1,
  "_links": {
    "self": {
      "href": "https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries?page=2&per_page=1"
    },
    "next": {
      "href": "https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries?page=3&per_page=1"
    },
    "prev": {
      "href": "https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries?page=1&per_page=1"
    },
    "first": {
      "href": "https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries?page=1&per_page=1"
    },
    "last": {
      "href": "https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries?page=3&per_page=1"
    }
  },
  "_embedded": {
    "entries": [
      {
        "id": "27b197c0-4a66-49e4-becb-50eff2be97b5",
        "do_not_call_list_id": "594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c",
        "phone_number": "+351929312312",
        "reason": "customer request",
        "expiration_date": "2021-12-31",
        "created_at": "2020-03-24T11:48:40.503Z",
        "updated_at": "2020-03-24T11:48:40.503Z",
        "_links": {
          "self": {
            "href": "https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c/entries/27b197c0-4a66-49e4-becb-50eff2be97b5"
          },
          "do-not-call-list": {
            "href": "https://api.talkdeskapp.com/do-not-call-lists/594ba829-8b1c-4ec2-bfc5-d5a26bafdf1c"
          }
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.