Do Not Contact

List Do Not Contact entries

Retrieve a paginated list of Do Not Contact entries with optional filtering by type, reason, and search term.

get/v3/user-api/do-not-contacts

Request

  • Base URL
    https://api.nureply.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared. Required headers: x-personal-api-key

Query parameters

type'email' | 'domain'

Filter by type

reason'unsubscribe' | 'bounce' | 'spam_complaint' | 'manual' | 'invalid' | 'other'

Filter by reason

searchstring
Example:example.com

Search by value (partial match)

pagenumber
Example:1

Page number (1-indexed)

limitnumber
Example:100

Items per page

sortBy'createdAt' | 'value' | 'type' | 'reason'

Sort field

sortOrder'asc' | 'desc'

Sort order

typestring

Filter by type

reasonstring

Filter by reason

searchstring
Example:example.com

Search by value (partial match)

pagenumber
Example:1

Page number (1-indexed)

limitnumber
Example:100

Items per page

sortBystring

Sort field

sortOrderstring

Sort order

Headers

x-personal-api-keystring required

API Key from Dashboard

Response

messagestring required
totalnumber required

Example response

{
  "message": "Retrieved DNC list successfully",
  "data": [
    {
      "value": "user@example.com",
      "type": "email",
      "reason": "unsubscribe",
      "_id": "653a2b0bf5444e11e5cdd1ce",
      "createdAt": "2023-10-26T11:11:25.365Z"
    }
  ],
  "total": 500,
  "pagination": {
    "page": 1,
    "limit": 50,
    "totalPages": 10,
    "hasMore": true
  }
}

Changes

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