Sign in

v1

latestOpenAPI 3.1.02026-07-26497885.9 KB

View an app

View the details of a single OneSignal app

get/apps/{app_id}

Path parameters

app_idstring required

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

Query parameters

view'config'

Set to config to return configuration-only data. This omits players and messageable_players, skipping the subscription-count lookup for a faster response.

Headers

Content-Typestring required
Authorizationstring required

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

Response

200

idstring

The OneSignal App ID in UUID v4 format.

namestring

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

playersinteger

The total number of Subscriptions in the app. Omitted when view=config is passed.

messageable_playersinteger

The number of Subscriptions eligible to receive messages in the app. Omitted when view=config is passed.

created_atstring

The date and time the app was created.

updated_atstring

The date and time the app was last updated.

organization_idstring

The Organization ID in which the app was created.

additional_data_is_root_payloadboolean

When true, custom additional data is sent at the root of the push payload instead of nested under a custom key (iOS only).

gcm_keystring

Legacy. The deprecated Google Cloud Messaging (GCM/FCM legacy) server API key. Retained for backward compatibility; use fcm_v1_service_account_json instead.

fcm_v1_service_account_jsonstring

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

fcm_sender_idstring

The FCM Sender ID associated with your Firebase project.

chrome_keystring

Legacy. The deprecated Google Chrome extension (GCM) API key. Retained for backward compatibility.

chrome_web_keystring

Web push VAPID public key for Chrome web push notifications.

chrome_web_originstring

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

chrome_web_gcm_sender_idstring

The GCM Sender ID used for web push notifications.

chrome_web_default_notification_iconstring

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

chrome_web_sub_domainstring

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

apns_envstring

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

apns_certificatesstring

The APNS p12 certificate for iOS push notifications.

apns_p8string

The APNs Auth Key (.p8) token-based credential for iOS push notifications.

apns_team_idstring

The Apple Developer Team ID associated with the APNs Auth Key.

apns_key_idstring

The Key ID of the APNs Auth Key (.p8).

apns_bundle_idstring

The app bundle ID associated with the APNs Auth Key.

safari_apns_certificatestring

The Safari APNs certificate, or "OneSignal Provided Certificate" when using a OneSignal-managed Safari certificate.

safari_site_originstring

The HTTPS origin URL configured for Safari web push.

safari_push_idstring

The Safari Web Push ID (website push ID / certificate bundle ID).

safari_icon_16_16string

URL to the 16x16px Safari notification icon.

safari_icon_32_32string

URL to the 32x32px Safari notification icon.

safari_icon_64_64string

URL to the 64x64px Safari notification icon.

safari_icon_128_128string

URL to the 128x128px Safari notification icon.

safari_icon_256_256string

URL to the 256x256px Safari notification icon.

site_namestring

The name of the website configured for web push.

conversion_attribution_window_pushinteger

Conversion (outcome) attribution window for push, in minutes.

conversion_attribution_window_iaminteger

Conversion (outcome) attribution window for in-app messages, in minutes.

conversion_attribution_window_emailinteger

Conversion (outcome) attribution window for email, in minutes.

conversion_attribution_window_smsinteger

Conversion (outcome) attribution window for SMS, in minutes.

channelsobject

Messaging channels available for this app, keyed by channel name. Each entry indicates whether the channel is enabled and which platforms are configured for it.