do-not-contact

Get Dnc Lists

get/v1/dnc

Query parameters

searchstring

Search by list name

pageSizenumber

Number of items per page. Maximum pageSize is 100

pagenumber

Page number for pagination.

sort'ASC' | 'DESC' required

Sort order for the results.

sortBy'total' | 'updatedAt' required

Field to sort the results by. Ex: lastUpdatedAt, total email and domain count

Response

Successfully fetched dnc list<br><br>

{"stackTrail":"paths:/v1/dnc:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"payload":{"message":"Successfully fetched dnc list","payload":[{"id":"vWjzRkZwAq","name":"Example List","numberOfItems":2,"createdAt":"2023-01-01T00:00:00.000Z","createdBy":"John Doe","clientId":1,"total":"15","updatedAt":"2024-06-26T03:23:13.573Z"}]}}}

Example response

{
  "payload": {
    "message": "Successfully fetched dnc list",
    "payload": [
      {
        "id": "vWjzRkZwAq",
        "name": "Example List",
        "numberOfItems": 2,
        "createdAt": "2023-01-01T00:00:00.000Z",
        "createdBy": "John Doe",
        "clientId": 1,
        "total": "15",
        "updatedAt": "2024-06-26T03:23:13.573Z"
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.