{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance/push_notifications/gcm/devices/","auth":"required","settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"language":"curl","code":"curl -X GET \\\n-H \"X-API-KEY: API_KEY\" \\\n\"https://api.syncano.io/v1.1/instances/INSTANCE/push_notifications/gcm/devices/\"\n"},{"name":"Python","language":"python","code":"import syncano\nfrom syncano.models import GCMDevice\n\nsyncano.connect(api_key=\"ACCOUNT_KEY\", instance_name=\"INSTANCE_NAME\")\n\ndevices = GCMDevice.please.list()\n\nfor device in devices:\n\t\tprint(device.registration_id)"},{"language":"javascript","code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar GCMDevice = connection.GCMDevice;\n\nvar query = {instanceName: \"INSTANCE_NAME\"};\n\nGCMDevice.please().list(query).then(function(devices) {\n\tconsole.log('Devices', devices);\n});"}]},"method":"get","params":[{"name":"instance","type":"string","default":"","desc":"Instance name","required":true,"in":"path","ref":"","_id":"56c51e58668eb01900719bcc"}],"results":{"codes":[{"status":200,"name":"","code":"{\n  \"prev\": null,\n  \"objects\": [\n    {\n      \"registration_id\": \"12345\",\n      \"user\": 1,\n      \"links\": {\n        \"self\": \"/v1.1/instances/INSTANCE/push_notifications/gcm/devices/12345/\",\n        \"config\": \"/v1.1/instances/INSTANCE/push_notifications/gcm/config/\",\n        \"send_message\": \"/v1.1/instances/INSTANCE/push_notifications/gcm/devices/12345/send_message/\"\n      },\n      \"created_at\": \"2016-02-18T01:34:27.187762Z\",\n      \"is_active\": true,\n      \"updated_at\": \"2016-02-18T01:34:27.187787Z\",\n      \"label\": \"DEVICE_NAME\",\n      \"metadata\": {},\n      \"device_id\": \"0x12345\"\n    }\n  ],\n  \"next\": null\n}","language":"json"}]}},"next":{"description":"","pages":[]},"title":"GCM Devices - list","type":"endpoint","slug":"gcm-devices-list","excerpt":"List your GCM Devices","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\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/gcm/devices/\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\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=0x13214\\\" \\\\\\n\\\"https://api.syncano.rocks/v1.1/instances/INSTANCE/push_notifications/gcm/devices/\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","updates":[],"order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c52090d70fed0d00160cd4","version":{"version":"0.1.1","version_clean":"0.1.1","codename":"API v1.1","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":true,"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"],"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z"},"githubsync":"","parentDoc":null,"user":"548193732dca603300bf6ea1","createdAt":"2016-02-18T01:38:24.551Z","editedParams":true,"editedParams2":true,"project":"54774d9af3736008009e9e0e","__v":0,"category":{"sync":{"isSync":false,"url":""},"pages":["56c506c40fba010d0043074d","56c506d673eb9a1700fbc90a","56c506e20fba010d0043074f","56c50cd718f0c90d002808e7","56c51e58668eb01900719bc9","56c51ea57de3580d00bdaf29","56c51fcf6889720d0099db00","56c52090d70fed0d00160cd4","56c5218cd1b8770d00922298","56c522eed1b8770d0092229d","56c5244773eb9a1700fbc918","56c524a373eb9a1700fbc919","56c6ad0c70e7660d004a899a","56c6af8ff133430d00b34018","56c6b0489d75580d00026225","56c6b09b38991717009a81f3"],"title":"Push Notifications (GCM)","slug":"push-notifications","order":17,"from_sync":false,"reference":true,"_id":"56c506a018f0c90d002808de","createdAt":"2016-02-17T23:47:44.305Z","project":"54774d9af3736008009e9e0e","__v":16,"version":"56c50626bdcde80d00498635"}}

getGCM Devices - list

List your GCM 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 [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/gcm/devices/\"", "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=0x13214\" \\\n\"https://api.syncano.rocks/v1.1/instances/INSTANCE/push_notifications/gcm/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 }}