do-not-contact
Get Dnc Lists
get/v1/dnc
Request
- Base URLhttps://developer.saleshandy.com (the document declares no server; this is the origin it was published from)
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
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>
unknown required
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 operation across all 4 revisions of this API.