Sign in
latestOpenAPI 3.1.02026-08-085123123.9 KB

bf0b51ee8e8a

Members

Retrieve unsubscribed members

Retrieve a paginated list of members who unsubscribed from your mailings.

get/members/unsubscribed

Query parameters

pageinteger

The page of results to view

limitinteger

The number of results per page (max 10 000)

sort'email_asc' | 'email_desc' | 'date_asc' | 'date_desc' | 'updated_asc' | 'updated_desc'

Sort order for results

unsubscribedOnFromstring date

Date (start of day) from which members unsubscribed (format: yyyy-mm-dd)

unsubscribedOnTostring date

Date (end of day) to which members unsubscribed (format: yyyy-mm-dd)

updatedOnFromstring date

Date (start of day) from which members were last updated (format: yyyy-mm-dd)

updatedOnTostring date

Date (end of day) to which members were last updated (format: yyyy-mm-dd)

Response

Paginated list of unsubscribed members

totalCountinteger
pageinteger
limitinteger
sortstring

Example response

{
  "members": [
    {
      "firstname": "John",
      "lastname": "Doe",
      "company": "John Doe Company inc",
      "email": "john.doe@example.org",
      "gender": "m",
      "language": "en_ca",
      "joinedOn": "2015-10-05 11:09:04.710",
      "updatedOn": "2016-12-10 12:41:42.020",
      "consentType": "implied",
      "postalCode": "A0A 0A0",
      "country": "CA",
      "note": "He's awesome",
      "unsubscribedOn": "2015-10-05 11:09:04.710",
      "customFields": {
        "1": "this is a test !",
        "2": 6544,
        "3": 1.5,
        "4": "2000-01-01"
      }
    }
  ],
  "totalCount": 215,
  "page": 1,
  "limit": 2
}