{"__v":0,"_id":"589942e7d207df0f000218d7","category":{"__v":0,"_id":"57f53fb368a53b2000e03f0f","project":"5588b8a2f6c18d0d005bba03","version":"5588b8a2f6c18d0d005bba06","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API"},"parentDoc":null,"project":"5588b8a2f6c18d0d005bba03","user":"5588b847f6c18d0d005bba01","version":{"__v":14,"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","createdAt":"2015-06-23T01:38:42.696Z","releaseDate":"2015-06-23T01:38:42.696Z","categories":["5588b8a3f6c18d0d005bba07","5588e9689cfea70d00371df3","5588f5921163180d00b64704","561598b121e9110d0078025a","5616f1c9d170d00d00189306","5616f5c3a410c90d00c6121e","561803dcf8c9632100ac7592","563667280441020d0000e9eb","5642570d9417b40d00c0fcd3","57bf5f02efe0050e00d50bd5","57f53fb368a53b2000e03f0f","57f55187440418170086325a","582e3afa72fd270f0006926d","5841faa973967b0f004b4a2b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-07T03:45:43.347Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl --header \"X-API-Token: <your token>\" https://api.mixmax.com/v1/unsubscribes","language":"curl"}]},"results":{"codes":[{"name":"","code":"{\n  \"results\": [\n    {\n      \"_id\": \"580aa34686e6e2194b25d79e\",\n      \"name\": \"John Smith\",\n      \"email\": \"john:::at:::mixmax.com\",\n      \"teamId\": \"kZYPwDDiGPTfQDj5n\",\n      \"messageId\": \"78abf1610ad702f1\"\n    }\n  ],\n  \"next\": \"eyIkb2lkIjoiNTgwYWEzNDY4NmU2ZTIxOTRiMjVkNzllIn0\"\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"589942e7d207df0f000218d9","ref":"","in":"query","required":false,"desc":"Field to sort by. One of: `name`, `email`, or `createdAt`","default":"createdAt","type":"string","name":"sort"},{"_id":"589942e7d207df0f000218d8","ref":"","in":"query","required":false,"desc":"True to sort ascending (A-Z)","default":"false","type":"boolean","name":"sortAscending"}],"url":"/v1/unsubscribes"},"isReference":true,"order":78,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"_id\",\n    \"0-1\": \"*String*\",\n    \"0-2\": \"Unique ID\",\n    \"1-0\": \"teamId\",\n    \"1-1\": \"*String*\",\n    \"1-2\": \"ID of the team the unsubscribe belongs to\",\n    \"2-0\": \"email\",\n    \"2-1\": \"*String*\",\n    \"2-2\": \"Lowercase email address of the recipient who unsubscribed\",\n    \"3-0\": \"name\",\n    \"3-1\": \"*String*\",\n    \"3-2\": \"(Optional) Name of the recipient who unsubscribed\",\n    \"4-0\": \"messageId\",\n    \"4-1\": \"*String*\",\n    \"4-2\": \"(Optional) ID of the message the unsubscribe originated from\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","excerpt":"Lists contacts who have unsubscribed to sequences","slug":"unsubscribes","type":"get","title":"/unsubscribes"}

get/unsubscribes

Lists contacts who have unsubscribed to sequences

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

sort:
stringcreatedAt
Field to sort by. One of: `name`, `email`, or `createdAt`
sortAscending:
booleanfalse
True to sort ascending (A-Z)

Examples


Result Format


Documentation

[block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Description", "0-0": "_id", "0-1": "*String*", "0-2": "Unique ID", "1-0": "teamId", "1-1": "*String*", "1-2": "ID of the team the unsubscribe belongs to", "2-0": "email", "2-1": "*String*", "2-2": "Lowercase email address of the recipient who unsubscribed", "3-0": "name", "3-1": "*String*", "3-2": "(Optional) Name of the recipient who unsubscribed", "4-0": "messageId", "4-1": "*String*", "4-2": "(Optional) ID of the message the unsubscribe originated from" }, "cols": 3, "rows": 5 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}