do-not-contact

Get Dnc items by id

get/v1/dnc/{dncListId}

Request

Base URL
https://developer.saleshandy.com (the document declares no server; this is the origin it was published from)
Auth
API key in header x-api-key

Path parameters

dncListIdstring required

Enter dnc list id

Query parameters

searchstring

Search by item value

pageSizenumber

Number of items per page. Maximum pageSize is 100

pagenumber

Page number for pagination.

type'all' | 'email' | 'domain' required

type of item

Response

Successfully fetched dnc item<br><br>

unknown required

Example response

{
  "payload": {
    "message": "Successfully fetched dnc item",
    "dncDetails": [
      {
        "id": "bZwpbE09aQ",
        "value": "test@gmail.com",
        "type": "email",
        "createdAt": "2024-09-19T07:44:00.100Z",
        "addedBy": "John Doe"
      }
    ],
    "meta": {
      "totalItems": 1,
      "currentPage": 1,
      "itemsPerPage": 25,
      "totalPages": 1,
      "itemCount": 1
    }
  }
}

Changes

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