Overview

Use this API to retrieve details of all of the OneSignal apps associated with your OneSignal user account.

How to use this API

Using your Organization API key (available in Organizations > Keys & IDs) you can retrieve a list of all of your apps and the properties of each app, including the name and ID of the app, the ID of the organization it is under, the associated APNs and FCM settings, total subscription count and messageable subscription count, and created and updated dates.

This API can return the REST API key for the apps under the basic_auth_key property. This is hidden by default. If you need access to this, contact OneSignal Support with the email associated with the Organization used in the requests. We can assist in enabling it on a user-basis.

Limitations

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.

Please contact [email protected] if you have any questions about this limit.

📘

Getting the basic_auth_key

For security reasons, the basic_auth_key value in the response will be returned as null by default. If you need access to this, contact OneSignal Support with the email associated with the User Auth Key used in the requests. We can assist in enabling it on a user-basis.