{"_id":"570f9e4153bfcc0e0037f3cf","githubsync":"","editedParams":true,"editedParams2":true,"parentDoc":null,"__v":0,"project":"54774d9af3736008009e9e0e","user":"54ad3a04f6f5b10b0066dc61","version":{"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z","categories":["56c50628bdcde80d00498636","56c50628bdcde80d00498637","56c50628bdcde80d00498638","56c50628bdcde80d00498639","56c50628bdcde80d0049863a","56c50628bdcde80d0049863b","56c50628bdcde80d0049863c","56c50628bdcde80d0049863d","56c50628bdcde80d0049863e","56c50628bdcde80d0049863f","56c50628bdcde80d00498640","56c50628bdcde80d00498641","56c50628bdcde80d00498642","56c50628bdcde80d00498643","56c50628bdcde80d00498644","56c50628bdcde80d00498645","56c50628bdcde80d00498646","56c50628bdcde80d00498647","56c506a018f0c90d002808de","56c6b0baf795cf0d003ec13e","56fe58eb5a08190e00085149","571764513cf2960e0009a635","571fc008ffbc6a2000b25bb5","5739ca371f4b740e00b06e09","577522f197a3830e004bcc1b","57753d5ffecd260e00d86ce6","57adb71efaa7a10e004495b6"],"is_deprecated":true,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"API v1.1","version_clean":"0.1.1","version":"0.1.1"},"category":{"_id":"56c6b0baf795cf0d003ec13e","pages":[],"__v":0,"project":"54774d9af3736008009e9e0e","version":"56c50626bdcde80d00498635","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-19T06:05:46.171Z","from_sync":false,"order":18,"slug":"push-notifications-apns","title":"Push Notifications (APNS)"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-14T13:42:25.207Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"prev\": null,\n  \"objects\": [\n    {\n      \"label\": \"device\", \n      \"user\": 1, \n      \"registration_id\": \"ID\", \n      \"device_id\": \"ID\", \n      \"metadata\": {}, \n      \"is_active\": true, \n      \"created_at\": \"2015-12-09T15:18:23.546600Z\", \n      \"updated_at\": \"2016-04-15T12:15:04.160304Z\", \n      \"links\": {\n        \"self\": \"/v1/instances/INSTANCE/push_notifications/apns/devices/ID/\", \n        \"config\": \"/v1/instances/INSTANCE/push_notifications/apns/config/\", \n        \"send_message\": \"/v1/instances/INSTANCE/push_notifications/apns/devices/ID/send_message/\"\n      }\n    }\n  ],\n  \"next\": null\n}","language":"json","status":200}]},"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"code":"curl -X GET \\\n-H \"X-API-KEY: API_KEY\" \\\n\"https://api.syncano.io/v1.1/instances/INSTANCE/push_notifications/apns/devices/\"\n","language":"curl"},{"name":"Python","code":"import syncano\nfrom syncano.models import APNSDevice\n\nsyncano.connect(api_key=\"ACCOUNT_KEY\", instance_name=\"INSTANCE_NAME\")\n\ndevices = APNSDevice.please.list()\n\nfor device in devices:\n\t\tprint(device.registration_id)","language":"python"},{"code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar APNSDevice = connection.APNSDevice;\n\nvar query = {instanceName: \"INSTANCE_NAME\"};\n\nAPNSDevice.please().list(query).then(function(devices) {\n\tconsole.log('Devices', devices);\n});","language":"javascript"}]},"method":"get","auth":"required","params":[{"_id":"56c51e58668eb01900719bcc","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance"}],"url":"/instances/:instance/push_notifications/apns/devices/"},"isReference":true,"order":4,"body":"You can filter the devices list results by adding additional query parameters. There are 2 fields that you can filter by:\n- `user` - list devices that belong to a user with a specified ID\n- `device_id` - find a device with a specified device ID\n\n### Listing devices by user ID\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X GET -G \\\\\\n-H \\\"X-API-KEY: API_KEY\\\" \\\\\\n-d \\\"user=1\\\" \\\\\\n\\\"https://api.syncano.rocks/v1.1/instances/INSTANCE/push_notifications/apns/devices/\\\"\\n\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n### Listing devices by device ID\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X GET -G \\\\\\n-H \\\"X-API-KEY: API_KEY\\\" \\\\\\n-d \\\"device_id=20a514f4-1195-4907-8732-de625bd2ed42\\\" \\\\\\n\\\"https://api.syncano.rocks/v1.1/instances/INSTANCE/push_notifications/apns/devices/\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","excerpt":"List your APNS Devices","slug":"apns-devices-list","type":"endpoint","title":"APNS Devices - list"}

getAPNS Devices - list

List your APNS Devices

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance:
required
string
Instance name

Examples


Result Format


Documentation

You can filter the devices list results by adding additional query parameters. There are 2 fields that you can filter by: - `user` - list devices that belong to a user with a specified ID - `device_id` - find a device with a specified device ID ### Listing devices by user ID [block:code] { "codes": [ { "code": "curl -X GET -G \\\n-H \"X-API-KEY: API_KEY\" \\\n-d \"user=1\" \\\n\"https://api.syncano.rocks/v1.1/instances/INSTANCE/push_notifications/apns/devices/\"\n", "language": "curl" } ] } [/block] ### Listing devices by device ID [block:code] { "codes": [ { "code": "curl -X GET -G \\\n-H \"X-API-KEY: API_KEY\" \\\n-d \"device_id=20a514f4-1195-4907-8732-de625bd2ed42\" \\\n\"https://api.syncano.rocks/v1.1/instances/INSTANCE/push_notifications/apns/devices/\"", "language": "curl" } ] } [/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 }}