Skip to main content
GET
/
apps
/
{app_id}
View an app
curl --request GET \
  --url https://api.onesignal.com/apps/{app_id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'
{
  "id": "<string>",
  "name": "<string>",
  "players": 123,
  "messageable_players": 123,
  "created_at": "<string>",
  "updated_at": "<string>",
  "organization_id": "<string>",
  "fcm_v1_service_account_json": "<string>",
  "fcm_sender_id": "<string>",
  "chrome_web_key": "<string>",
  "chrome_web_origin": "<string>",
  "chrome_web_gcm_sender_id": "<string>",
  "chrome_web_default_notification_icon": "<string>",
  "chrome_web_sub_domain": "<string>",
  "apns_env": "<string>",
  "apns_certificates": "<string>",
  "apns_p8": "<string>",
  "apns_team_id": "<string>",
  "apns_key_id": "<string>",
  "apns_bundle_id": "<string>",
  "site_name": "<string>"
}

​
Overview

Use this API to retrieve metadata and platform configuration for a single OneSignal app associated with your account. This includes app names, App ID, Subscription counts, timestamps, and push platform credentials (Android/FCM, iOS/APNS, Web Push, Safari), making it easy to programmatically manage or audit your applications.
This API does not return the app’s API keys. To manage API keys, use the Create API Key, Rotate API Key, and Delete API Key APIs.

​
How to use this API

To retrieve your app, send a GET request to the /apps endpoint using your Organization API Key. This key can be found in your OneSignal dashboard under Organization > Keys & IDs.

Headers

​
Content-Type
string
default:application/json
required
​
Authorization
string
default:Key YOUR_ORGANIZATION_API_KEY
required

Your Organization API key with prefix Key. See Keys & IDs.

Path Parameters

​
app_id
string
required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

Response

200 - application/json

200

​
id
string

The OneSignal App ID in UUID v4 format.

​
name
string

An internal name you set to help organize and track Apps. Maximum 128 characters.

​
players
integer

The total number of Subscriptions in the app.

​
messageable_players
integer

The number of Subscriptions eligible to receive messages in the app.

​
created_at
string

The date and time the app was created.

​
updated_at
string

The date and time the app was last updated.

​
organization_id
string

The Organization ID in which the app was created.

​
fcm_v1_service_account_json
string

Your FCM Service Account JSON file for Android push notifications. See Android: Firebase Credentials.

​
fcm_sender_id
string

The FCM Sender ID associated with your Firebase project.

​
chrome_web_key
string

Web push VAPID public key for Chrome web push notifications.

​
chrome_web_origin
string

The HTTPS origin URL for your website. Required for web push notifications.

​
chrome_web_gcm_sender_id
string

The GCM Sender ID used for web push notifications.

​
chrome_web_default_notification_icon
string

The full HTTPS URL to your default notification icon. Should be a 256x256px PNG.

​
chrome_web_sub_domain
string

The OneSignal subdomain for web push if not using your own origin.

​
apns_env
string

The APNS environment: production or development. See iOS SDK Setup.

​
apns_certificates
string

The APNS p12 certificate for iOS push notifications. See p12 APNS Authentication.

​
apns_p8
string

The APNS p8 token key for iOS push notifications. See p8 Token-based connection to APNS.

​
apns_team_id
string

The Apple Team ID associated with your APNS credentials.

​
apns_key_id
string

The APNS Key ID for p8 token-based authentication.

​
apns_bundle_id
string

The iOS app Bundle ID associated with your APNS credentials.

​
site_name
string

The name of your website, used for web push notification titles.