- Quick Start
- Send Survey
- Get Contact
- Remove Contact
- Delete Contact (GDPR)
- Get Unsubscribed
- Get Responses
- Get NPS
- Sent Statistics
- Historical Stats
- Deactivate All
- Bulk Add with CSV
- Inapp Surveys
- Bulk Add/Send
Change Log
Get a list of all unsubscribed contacts
This will return a json array of customers that have manually unsubscribed from AskNicely surveys using our unsubscribe link on the footer of our emails
Example GET request
Get the JSON unsubscribed listcurl --header "X-apikey: " \ https://DEMO.asknice.ly/api/v1/contacts/unsubscribedOptional Arguments
Argument | Type | Example | Required | Description |
---|---|---|---|---|
pagenumber |
integer |
1 |
optional | Start querying the contacts from "pagenumber". This value should be greater than 0. |
pagesize |
integer |
1000 |
optional | "pagesize" of rows will be returned in the response. This value should be greater than 0. |
- "id" below is the contact ID, same as "contact_id" from Get Responses and the "id" returned by Send Survey.
- Pagination is optional, if it is used, the parameter of "pagenumber" must to be set. If the parameter of "pagesize" is NOT set, by default, 1000 records are returned.
Example Request when using optional pagination
curl --header "X-apikey: " \ "https://DEMO.asknice.ly/api/v1/contacts/unsubscribed?pagenumber=1&pagesize=1000"
Example Response
{ "success":true, "data":[ { "id":"15816", "unsubscribetime":"1452219376", "email":"test@example.com" },{ "id":"16838", "unsubscribetime":"14522193485", "email":"test2@example.com" }, ] }