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>"
}

​
Overview

Use this API to retrieve metadata for a single OneSignal app associated with your account. This includes app names, App ID, Subscription counts, and timestamps, 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.