---
title: "View an app"
method: GET
path: "/apps/{app_id}"
---

# View an app

`GET /apps/{app_id}`

View the details of a single OneSignal app

## Path parameters

- `app_id` string, required

## Query parameters

- `view` 'config'

## Headers

- `Content-Type` string, required
- `Authorization` string, required

## Response `200`

200

- object
  - `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. Omitted when `view=config` is passed.
  - `messageable_players` integer — The number of Subscriptions eligible to receive messages in the app. Omitted when `view=config` is passed.
  - `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.
  - `additional_data_is_root_payload` boolean — When `true`, custom additional data is sent at the root of the push payload instead of nested under a `custom` key (iOS only).
  - `gcm_key` string — **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_json` string — Your FCM Service Account JSON file for Android push notifications. See [Android: Firebase Credentials](/docs/android-firebase-credentials).
  - `fcm_sender_id` string — The FCM Sender ID associated with your Firebase project.
  - `chrome_key` string — **Legacy.** The deprecated Google Chrome extension (GCM) API key. Retained for backward compatibility.
  - `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](/docs/ios-sdk-setup).
  - `apns_certificates` string — The APNS p12 certificate for iOS push notifications.
  - `apns_p8` string — The APNs Auth Key (.p8) token-based credential for iOS push notifications.
  - `apns_team_id` string — The Apple Developer Team ID associated with the APNs Auth Key.
  - `apns_key_id` string — The Key ID of the APNs Auth Key (.p8).
  - `apns_bundle_id` string — The app bundle ID associated with the APNs Auth Key.
  - `safari_apns_certificate` string — The Safari APNs certificate, or "OneSignal Provided Certificate" when using a OneSignal-managed Safari certificate.
  - `safari_site_origin` string — The HTTPS origin URL configured for Safari web push.
  - `safari_push_id` string — The Safari Web Push ID (website push ID / certificate bundle ID).
  - `safari_icon_16_16` string — URL to the 16x16px Safari notification icon.
  - `safari_icon_32_32` string — URL to the 32x32px Safari notification icon.
  - `safari_icon_64_64` string — URL to the 64x64px Safari notification icon.
  - `safari_icon_128_128` string — URL to the 128x128px Safari notification icon.
  - `safari_icon_256_256` string — URL to the 256x256px Safari notification icon.
  - `site_name` string — The name of the website configured for web push.
  - `conversion_attribution_window_push` integer — Conversion (outcome) attribution window for push, in minutes.
  - `conversion_attribution_window_iam` integer — Conversion (outcome) attribution window for in-app messages, in minutes.
  - `conversion_attribution_window_email` integer — Conversion (outcome) attribution window for email, in minutes.
  - `conversion_attribution_window_sms` integer — Conversion (outcome) attribution window for SMS, in minutes.
  - `channels` object — 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.

## Other responses

- `403` — Forbidden. The Authorization key does not have permission to view this app.
- `404` — App not found. Either the App ID is wrong or your API key cannot reach this app's organization.
- `429` — Rate limit exceeded. Wait the number of seconds in the `Retry-After` header before retrying.
- `503` — Service temporarily unavailable. Retry after a short backoff. The body may be empty or non-JSON in some failure modes.

---

[API](https://skmtc.net/onesignal/apis/api-onesignal-com.md) · [All operations](https://skmtc.net/onesignal/apis/api-onesignal-com/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onesignal/api-onesignal-com/versions/0fc223f7e338/schema)
