Skip to main content

List of all unsubscribes

This endpoint retrieves all your unsubscribes.

Request​

GET https://api.nicereply.com/unsubscribes

By default, list of unsubscribes is sorted by unsubscribed_at.

Query Parameters​

Pagination is supported.

ParameterRequiredDefaultDescription
sort_orderNodescValid values is: asc or desc.

Example response​

200 OK
{
  "data": [
    {
      "id": "7a236a57-c9e9-4357-8bf7-587c59fec4f8",
      "legacy_id": 2370414,
      "email": "aaron+burnett@example.tld",
      "email_hash": "f7b747fad543652e68e020e54777876d54023f8f3aab8c71b14ca0c0d6dd7fc6",
      "unsubscribed_at": "2023-07-31T16:42:57+02:00"
    },
    {
      "id": "d102e5d8-4dbc-41c4-b1ea-52a00638c86b",
      "legacy_id": 3151711,
      "email": null,
      "email_hash": "d73a9a31710e669a67ed4cc4f26d3a42385b2485e4db2e7c5c4660e9f8252e92",
      "unsubscribed_at": "2023-07-23T11:23:02+02:00"
    }
    // ...
  ],
  "pagination": {
    "total": 30,
    "count": 10,
    "per_page": 10,
    "current_page": 1,
    "total_pages": 3,
    "links": {
      "next": "/unsubscribes?page=2",
      "prev": null
    }
  }
}