Overview
Use this API to retrieve metadata for all OneSignal apps associated with your account. This includes app names, App IDs, 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.
This API is limited to return a maximum of 1000 Apps. If you need access to more, then you should store the
app_id
and name
for each of your apps on your own server to look up with the View an app API to get data for each app separately. Also, if you need to delete apps, then you can provide the app_id
and name
to OneSignal Support and ask for these to be deleted.How to use this API
To retrieve your apps, send aGET
request to the /apps
endpoint using your Organization API Key. This key can be found in your OneSignal dashboard under Organization > Keys & IDs.
Headers
Your Organization API key with prefix Key
. See Keys & IDs.
Response
200 - application/json
200
The OneSignal App ID in UUID v4 format.
An internal name you set to help organize and track Apps. Maximum 128 characters.
The total number of Subscriptions in the app.
The number of Subscriptions eligible to receive messages in the app.
The date and time the app was created.
The date and time the app was last updated.
The Organization ID in which the app was created.