{"_id":"58d0f785187fdb0f002dc093","category":{"_id":"564bbc7e8841060d00abb2ee","__v":10,"pages":["564bbf454bf5c80d0020901e","564bc1b08b1c5521002bb914","564c387b9baa330d00faa622","564c3a7b61008d17006ffa3a","564c3e4083b72c2b00b36fb6","564c431b61008d17006ffa46","564c4bc9b9cdb41700a0eae7","564c4e955f9d102b00fc3b4a","564c5f32c241881700d85981","564c68a93eb8f81700838a25"],"project":"54aa7f773b56130b0056c86e","version":"55781fe25129590d003ff4f7","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-11-17T23:47:10.058Z","from_sync":false,"order":1,"slug":"pulsate-cms-api","title":"Pulsate CMS API"},"user":"54aa7f3f9bb00c0b00cb899b","githubsync":"","project":"54aa7f773b56130b0056c86e","__v":1,"version":{"_id":"55781fe25129590d003ff4f7","project":"54aa7f773b56130b0056c86e","forked_from":"54aa7f773b56130b0056c871","__v":6,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z","categories":["55781fe35129590d003ff4f8","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","55781fe35129590d003ff4fb","55781fe35129590d003ff4fc","55781fe35129590d003ff4fd","55781fe35129590d003ff4fe","564bbc7e8841060d00abb2ee","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","582318b23b961a0f009516a1","594a848c9f4771001a43c959"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Developers","version_clean":"2.0.0","version":"2.0"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-03-21T09:51:01.117Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"564bbbf80cbcc91700b8171c","results":{"codes":[{"language":"json","status":200,"name":"","code":"[\n  {\n  \t\"alias\": \"test\",\n  \t\"device_guids\": ['test-guid-1', 'test-guid-2'],\n  \t\"last_opt_out_at\": \"2017-01-01T08:00:00+00:00\",\n\t},\n  {\n  \t\"alias\": \"test-2\",\n  \t\"device_guids\": ['test-guid-3'],\n  \t\"last_opt_out_at\": \"2017-01-02T08:00:00+00:00\",\n\t},\n]"}]},"method":"get","examples":{"codes":[{"language":"shell","code":"curl -X GET \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/push_opt_outs\"\n\t-H \"Authorization: Token token=$MY_ADMIN_API_TOKEN\"","name":""}]},"auth":"required","params":[{"_id":"57ff8306159c7e0e003c4826","ref":"","in":"path","required":true,"desc":"App ID. It can be fetched by using \"Apps: Get All (Index)\" or \"Apps: Get One (Show)\" endpoints.","default":"","type":"string","name":"app_id"},{"_id":"564bbf454bf5c80d0020901f","ref":"","in":"path","required":false,"desc":"","default":"1","type":"int","name":"page"}],"url":"/apps/:app_id/push_opt_outs?page=:page"},"isReference":true,"order":46,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Getting more than 1000 opt outs\",\n  \"body\": \"The maximum number of users returned on one page is 1000. If there is more than a thousand opt outs a _page_ parameter has to be used to obtain all of them. Individual records are sorted by the  opt out date, meaning that the first page has the most recent and the last the least recent opt outs.\"\n}\n[/block]","excerpt":"","slug":"push-opt-outs-get-all","type":"endpoint","title":"Push Opt Outs: Get All"}

getPush Opt Outs: Get All


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

app_id:
required
string
App ID. It can be fetched by using "Apps: Get All (Index)" or "Apps: Get One (Show)" endpoints.
page:
integer1

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Getting more than 1000 opt outs", "body": "The maximum number of users returned on one page is 1000. If there is more than a thousand opt outs a _page_ parameter has to be used to obtain all of them. Individual records are sorted by the opt out date, meaning that the first page has the most recent and the last the least recent opt outs." } [/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 }}