{"__v":1,"_id":"551ef4f04986f62b00a7205f","category":{"__v":4,"_id":"551ef4ef4986f62b00a72038","pages":["551ef4f04986f62b00a7205d","551ef4f04986f62b00a7205e","551ef4f04986f62b00a7205f","551ef4f04986f62b00a72060","551ef4f04986f62b00a72061","551ef4f04986f62b00a72062","551ef4f04986f62b00a72063","551ef4f04986f62b00a72064","551ef4f04986f62b00a72065","551ef4f04986f62b00a72066","551ef4f04986f62b00a72067","551ef4f04986f62b00a72068","551ef4f04986f62b00a72069","551ef4f04986f62b00a7206a","551ef4f04986f62b00a7206b","551ef4f04986f62b00a7206c","5523150ae20da719000e78c2","5641731cb0dc090d00f88398","56c2761847394f0d00e2285e"],"project":"542b6018044e1e2200413772","version":"551ef4ef4986f62b00a7202e","reference":false,"createdAt":"2014-10-22T01:34:57.891Z","from_sync":false,"order":16,"slug":"server-rest-api","title":"Server REST API"},"parentDoc":null,"project":"542b6018044e1e2200413772","user":"542b6010044e1e220041376f","version":{"__v":7,"_id":"551ef4ef4986f62b00a7202e","forked_from":"542b6018044e1e2200413775","project":"542b6018044e1e2200413772","createdAt":"2015-04-03T20:15:43.149Z","releaseDate":"2015-04-03T20:15:43.149Z","categories":["551ef4ef4986f62b00a7202f","551ef4ef4986f62b00a72030","551ef4ef4986f62b00a72031","551ef4ef4986f62b00a72032","551ef4ef4986f62b00a72033","551ef4ef4986f62b00a72034","551ef4ef4986f62b00a72035","551ef4ef4986f62b00a72036","551ef4ef4986f62b00a72037","551ef4ef4986f62b00a72038","551ef4ef4986f62b00a72039","551ef4ef4986f62b00a7203a","551ef4ef4986f62b00a7203b","551ef4ef4986f62b00a7203c","551ef4ef4986f62b00a7203d","551ef4ef4986f62b00a7203e","55d7f1879510f00d007ec727","56b94a5a9fc0de1700b60ae9","56bd0e48ac1c5c1900b2dbe4","56d74afc3eb4dd0b0020196a","5723ab8a1f41110e003081ed","576b4dd327d6252b00085422"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"updates":["56eae3d0eed93a0e00dd5021"],"createdAt":"2014-10-21T23:48:43.346Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  id: \"92911750-242d-4260-9e00-9d9034f139ce\",\n  name: \"Your app 1\",\n  players: 150,\n  messagable_players: 143,\n  updated_at: \"2014-04-01T04:20:02.003Z\",\n  created_at: \"2014-04-01T04:20:02.003Z\",\n  gcm_key: \"a gcm push key\",\n  chrome_key: \"A Chrome Web Push GCM key\",\n  chrome_web_origin: \"Chrome Web Push Site URL\",\n  chrome_web_gcm_sender_id: \"Chrome Web Push GCM Sender ID\",\n  chrome_web_default_notification_icon: \"http://yoursite.com/chrome_notification_icon\",\n  chrome_web_sub_domain:\"your_site_name\",\n  apns_env: \"sandbox\",\n  apns_certificates: \"Your apns certificate\",\n  safari_apns_cetificate: \"Your Safari APNS certificate\",\n  safari_site_origin: \"The homename for your website for Safari Push, including http or https\",\n  safari_push_id: \"The certificate bundle ID for Safari Web Push\",\n  safari_icon_16_16: \"http://onesignal.com/safari_packages/92911750-242d-4260-9e00-9d9034f139ce/16x16.png\",\n  safari_icon_32_32: \"http://onesignal.com/safari_packages/92911750-242d-4260-9e00-9d9034f139ce/16x16:::at:::2.png\",\n  safari_icon_64_64: \"http://onesignal.com/safari_packages/92911750-242d-4260-9e00-9d9034f139ce/[email protected]\",\n  safari_icon_128_128: \"http://onesignal.com/safari_packages/92911750-242d-4260-9e00-9d9034f139ce/128x128.png\",\n  safari_icon_256_256: \"http://onesignal.com/safari_packages/92911750-242d-4260-9e00-9d9034f139ce/[email protected]\",\n  site_name: \"The URL to your website for Web Push\",  \n  basic_auth_key: \"NGEwMGZmMjItY2NkNy0xMWUzLTk5ZDUtMDAwYzI5NDBlNjJj\"\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5446f0dbe12a270800028a00","ref":"","required":false,"desc":"An app id","default":"","type":"string","name":"id"}],"url":"/apps/:id"},"isReference":false,"order":3,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Result Format\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  id: \\\"92911750-242d-4260-9e00-9d9034f139ce\\\",\\n  name: \\\"Your app 1\\\",\\n  players: 150,\\n  messageable_players: 143,\\n  updated_at: \\\"2014-04-01T04:20:02.003Z\\\",\\n  created_at: \\\"2014-04-01T04:20:02.003Z\\\",\\n  gcm_key: \\\"a gcm push key\\\",\\n  chrome_key: \\\"A Chrome Web Push GCM key\\\",\\n  chrome_web_origin: \\\"Chrome Web Push Site URL\\\",\\n  chrome_web_gcm_sender_id: \\\"Chrome Web Push GCM Sender ID\\\",\\n  chrome_web_default_notification_icon: \\\"http://yoursite.com/chrome_notification_icon\\\",\\n  chrome_web_sub_domain:\\\"your_site_name\\\",\\n  apns_env: \\\"sandbox\\\",\\n  apns_certificates: \\\"Your apns certificate\\\",\\n  safari_apns_cetificate: \\\"Your Safari APNS certificate\\\",\\n  safari_site_origin: \\\"The homename for your website for Safari Push, including http or https\\\",\\n  safari_push_id: \\\"The certificate bundle ID for Safari Web Push\\\",\\n  safari_icon_16_16: \\\"http://onesignal.com/safari_packages/92911750-242d-4260-9e00-9d9034f139ce/16x16.png\\\",\\n  safari_icon_32_32: \\\"http://onesignal.com/safari_packages/92911750-242d-4260-9e00-9d9034f139ce/[email protected]\\\",\\n  safari_icon_64_64: \\\"http://onesignal.com/safari_packages/92911750-242d-4260-9e00-9d9034f139ce/[email protected]\\\",\\n  safari_icon_128_128: \\\"http://onesignal.com/safari_packages/92911750-242d-4260-9e00-9d9034f139ce/128x128.png\\\",\\n  safari_icon_256_256: \\\"http://onesignal.com/safari_packages/92911750-242d-4260-9e00-9d9034f139ce/[email protected]\\\",\\n  site_name: \\\"The URL to your website for Web Push\\\",  \\n  basic_auth_key: \\\"NGEwMGZmMjItY2NkNy0xMWUzLTk5ZDUtMDAwYzI5NDBlNjJj\\\"\\n}\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Auth Key Required\",\n  \"body\": \"Requires your OneSignal User Auth Key\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --include \\\\\\n     --header \\\"Content-Type: application/json\\\" \\\\\\n     --header \\\"Authorization: Basic NGEwMGZmMjItY2NkNy0xMWUzLTk5ZDUtMDAwYzI5NDBlNjJj\\\" \\\\\\n https://onesignal.com/api/v1/apps/e4e87830-b954-11e3-811d-f3b376925f15\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    },\n    {\n      \"code\": \"\\t\\t$ch = curl_init();\\n    curl_setopt($ch, CURLOPT_URL, \\\"https://onesignal.com/api/v1/apps/YOUR_APP_ID\\\");\\n    curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json',\\n                           'Authorization: Basic YOUR_USER_AUTH_KEY'));\\n    curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);\\n    curl_setopt($ch, CURLOPT_HEADER, FALSE);\\n    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);\\n\\n    $response = curl_exec($ch);\\n\\t\\t$response = json_decode($response, true);\\n    curl_close($ch);\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]","excerpt":"View the details of a single OneSignal app","slug":"appsid","type":"get","title":"/apps/:id (View an app)"}

Introduction

iOS

Android

Amazon

Windows Phone

Chrome Apps/Extensions

Mac OS X

Website Push

Corona SDK

Unity SDK

Marmalade SDK

Adobe Air

PhoneGap, Cordova, Ionic

Xamarin SDK

React Native

Cocos2d-x

Server REST API

Troubleshooting

Miscellaneous

get/apps/:id (View an app)

View the details of a single OneSignal app

Definition

{{ api_url }}{{ page_api_url }}

Parameters

id:
string
An app id

Result Format

Documentation

[block:api-header] { "type": "basic", "title": "Result Format" } [/block] [block:code] { "codes": [ { "code": "{\n id: \"92911750-242d-4260-9e00-9d9034f139ce\",\n name: \"Your app 1\",\n players: 150,\n messageable_players: 143,\n updated_at: \"2014-04-01T04:20:02.003Z\",\n created_at: \"2014-04-01T04:20:02.003Z\",\n gcm_key: \"a gcm push key\",\n chrome_key: \"A Chrome Web Push GCM key\",\n chrome_web_origin: \"Chrome Web Push Site URL\",\n chrome_web_gcm_sender_id: \"Chrome Web Push GCM Sender ID\",\n chrome_web_default_notification_icon: \"http://yoursite.com/chrome_notification_icon\",\n chrome_web_sub_domain:\"your_site_name\",\n apns_env: \"sandbox\",\n apns_certificates: \"Your apns certificate\",\n safari_apns_cetificate: \"Your Safari APNS certificate\",\n safari_site_origin: \"The homename for your website for Safari Push, including http or https\",\n safari_push_id: \"The certificate bundle ID for Safari Web Push\",\n safari_icon_16_16: \"http://onesignal.com/safari_packages/92911750-242d-4260-9e00-9d9034f139ce/16x16.png\",\n safari_icon_32_32: \"http://onesignal.com/safari_packages/92911750-242d-4260-9e00-9d9034f139ce/[email protected]\",\n safari_icon_64_64: \"http://onesignal.com/safari_packages/92911750-242d-4260-9e00-9d9034f139ce/[email protected]\",\n safari_icon_128_128: \"http://onesignal.com/safari_packages/92911750-242d-4260-9e00-9d9034f139ce/128x128.png\",\n safari_icon_256_256: \"http://onesignal.com/safari_packages/92911750-242d-4260-9e00-9d9034f139ce/[email protected]\",\n site_name: \"The URL to your website for Web Push\", \n basic_auth_key: \"NGEwMGZmMjItY2NkNy0xMWUzLTk5ZDUtMDAwYzI5NDBlNjJj\"\n}", "language": "text" } ] } [/block] [block:callout] { "type": "warning", "title": "Auth Key Required", "body": "Requires your OneSignal User Auth Key" } [/block] [block:code] { "codes": [ { "code": "curl --include \\\n --header \"Content-Type: application/json\" \\\n --header \"Authorization: Basic NGEwMGZmMjItY2NkNy0xMWUzLTk5ZDUtMDAwYzI5NDBlNjJj\" \\\n https://onesignal.com/api/v1/apps/e4e87830-b954-11e3-811d-f3b376925f15", "language": "curl", "name": "cURL" }, { "code": "\t\t$ch = curl_init();\n curl_setopt($ch, CURLOPT_URL, \"https://onesignal.com/api/v1/apps/YOUR_APP_ID\");\n curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json',\n 'Authorization: Basic YOUR_USER_AUTH_KEY'));\n curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);\n curl_setopt($ch, CURLOPT_HEADER, FALSE);\n curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);\n\n $response = curl_exec($ch);\n\t\t$response = json_decode($response, true);\n curl_close($ch);", "language": "php" } ] } [/block]