do-not-contact
Search DNC item across all lists
get/v1/dnc/item/search
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 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 list with items<br><br>
Example response
{
"message": "Successfully fetched dnc item",
"payload": {
"dncList": [
{
"id": "9pa8lvQay2",
"name": "Global Do Not Contact List",
"numberOfItems": 2,
"createdAt": "2024-08-14T05:29:42.734Z",
"updatedAt": "2024-11-15T03:53:20.811Z",
"addedBy": "John Patel",
"ownerId": "9KwOp8YP6k",
"dncItems": [
{
"id": "9KwONr6Yz6",
"value": "abc@gmail.com",
"type": "email",
"createdAt": "2024-11-15T03:53:20.814Z"
}
]
}
],
"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.