curl --request GET \
--url https://api.onesignal.com/apps \
--header 'Authorization: <authorization>'import Onesignal from '@onesignal/node-onesignal';
const configuration = Onesignal.createConfiguration({
organizationApiKey: 'YOUR_ORGANIZATION_API_KEY',
});
const apiInstance = new Onesignal.DefaultApi(configuration);
try {
const response = await apiInstance.getApps();
console.log(response);
} catch (e) {
if (e instanceof Onesignal.ApiException) {
// `e.errorMessages` flattens any error-envelope shape to a `string[]`;
// the raw parsed body remains on `e.body`.
console.error("getApps failed: HTTP " + e.code, e.errorMessages);
} else {
throw e;
}
}import onesignal
from onesignal.api import default_api
from onesignal.models import *
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY.
# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself.
configuration = onesignal.Configuration(
rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints
organization_api_key = "YOUR_ORGANIZATION_API_KEY" # Organization key is only required for creating new apps and other top-level endpoints
)
# Enter a context with an instance of the API client
with onesignal.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = default_api.DefaultApi(api_client)
# example, this endpoint has no required or optional parameters
try:
# View apps
api_response = api_instance.get_apps()
pprint(api_response)
except onesignal.ApiException as e:
print("Exception when calling DefaultApi->get_apps: %s\n" % e)
print("Status Code: %s" % e.status)
print("Response Body: %s" % e.body)<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: organization_api_key
$config = onesignal\client\Configuration::getDefaultConfiguration()
->setRestApiKeyToken('YOUR_REST_API_KEY')
->setOrganizationApiKeyToken('YOUR_ORGANIZATION_API_KEY');
$apiInstance = new onesignal\client\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->getApps();
print_r($result);
} catch (\onesignal\client\ApiException $e) {
echo 'Exception when calling DefaultApi->getApps: ', $e->getMessage(), PHP_EOL;
echo 'Status Code: ', $e->getCode(), PHP_EOL;
// getErrorMessages() flattens any error-envelope shape to a string[];
// the raw body remains on getResponseBody().
echo 'Error Messages: ', implode(', ', $e->getErrorMessages()), PHP_EOL;
echo 'Response Body: ', $e->getResponseBody(), PHP_EOL;
} catch (\Exception $e) {
echo 'Exception when calling DefaultApi->getApps: ', $e->getMessage(), PHP_EOL;
}package main
import (
"context"
"fmt"
"os"
"github.com/OneSignal/onesignal-go-api/v5"
)
func main() {
configuration := onesignal.NewConfiguration()
apiClient := onesignal.NewAPIClient(configuration)
orgAuth := context.WithValue(context.Background(), onesignal.OrganizationApiKey, "YOUR_ORGANIZATION_API_KEY") // Organization API key is only required for creating new apps and other top-level endpoints
resp, r, err := apiClient.DefaultApi.GetApps(orgAuth).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.GetApps``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
if apiErr, ok := err.(*onesignal.GenericOpenAPIError); ok {
// ErrorMessages() flattens any error-envelope shape to a []string;
// the raw body remains on Body().
fmt.Fprintf(os.Stderr, "Error Messages: %v\n", apiErr.ErrorMessages())
fmt.Fprintf(os.Stderr, "Response Body: %s\n", apiErr.Body())
}
}
// response from `GetApps`: []App
fmt.Fprintf(os.Stdout, "Response from `DefaultApi.GetApps`: %v\n", resp)
}require 'onesignal'
# setup authorization
OneSignal.configure do |config|
# Configure Bearer authorization: organization_api_key
config.organization_api_key = 'YOUR_ORGANIZATION_API_KEY'
end
api_instance = OneSignal::DefaultApi.new
begin
# View apps
result = api_instance.get_apps
p result
rescue OneSignal::ApiError => e
puts "Error when calling DefaultApi->get_apps: #{e}"
puts "Status Code: #{e.code}"
# `e.error_messages` flattens any error-envelope shape to an Array<String>;
# the raw body remains on `e.response_body`.
puts "Error Messages: #{e.error_messages}"
puts "Response Body: #{e.response_body}"
end// Import classes:
import java.util.List;
import com.onesignal.client.ApiClient;
import com.onesignal.client.ApiException;
import com.onesignal.client.Configuration;
import com.onesignal.client.auth.*;
import com.onesignal.client.model.*;
import com.onesignal.client.api.DefaultApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.onesignal.com");
// Configure HTTP bearer authorization: organization_api_key
HttpBearerAuth organization_api_key = (HttpBearerAuth) defaultClient.getAuthentication("organization_api_key");
organization_api_key.setBearerToken("YOUR_ORGANIZATION_API_KEY");
DefaultApi apiInstance = new DefaultApi(defaultClient);
try {
List<App> result = apiInstance.getApps();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getApps");
System.err.println("Status code: " + e.getCode());
// getErrorMessages() flattens any error-envelope shape to a List<String>;
// the raw body remains on getResponseBody().
System.err.println("Error messages: " + e.getErrorMessages());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}using System;
using System.Collections.Generic;
using System.Diagnostics;
using OneSignalApi.Api;
using OneSignalApi.Client;
using OneSignalApi.Model;
namespace Example
{
public class GetAppsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.onesignal.com";
// Configure Bearer token for authorization: organization_api_key
config.AccessToken = "YOUR_ORGANIZATION_API_KEY";
var apiInstance = new DefaultApi(config);
try
{
// View apps
List<App> result = apiInstance.GetApps();
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetApps: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
// e.ErrorMessages flattens any error-envelope shape to an IReadOnlyList<string>;
// the raw body remains on e.ErrorContent.
Debug.Print("Error Messages: " + string.Join(", ", e.ErrorMessages));
Debug.Print("Response Body: " + e.ErrorContent);
Debug.Print(e.StackTrace);
}
}
}
}use onesignal_rust_api::apis::configuration::Configuration;
use onesignal_rust_api::apis::default_api;
#[tokio::main]
async fn main() {
let mut configuration = Configuration::new();
configuration.organization_api_key_token = Some("YOUR_ORGANIZATION_API_KEY".to_string());
match default_api::get_apps(&configuration).await {
Ok(resp) => println!("{:?}", resp),
Err(e @ onesignal_rust_api::apis::Error::ResponseError(_)) => {
// `e.error_messages()` flattens any error-envelope shape to a Vec<String>;
// the raw response remains on the ResponseError variant.
eprintln!("get_apps failed: {:?}", e.error_messages());
}
Err(e) => eprintln!("get_apps failed: {:?}", e),
}
}[
{
"id": "<string>",
"name": "<string>",
"players": 123,
"messageable_players": 123,
"created_at": "<string>",
"updated_at": "<string>",
"organization_id": "<string>",
"additional_data_is_root_payload": true,
"gcm_key": "<string>",
"fcm_v1_service_account_json": "<string>",
"fcm_sender_id": "<string>",
"chrome_key": "<string>",
"chrome_web_key": "<string>",
"chrome_web_origin": "<string>",
"chrome_web_gcm_sender_id": "<string>",
"chrome_web_default_notification_icon": "<string>",
"chrome_web_sub_domain": "<string>",
"apns_env": "<string>",
"apns_certificates": "<string>",
"apns_p8": "<string>",
"apns_team_id": "<string>",
"apns_key_id": "<string>",
"apns_bundle_id": "<string>",
"safari_apns_certificate": "<string>",
"safari_site_origin": "<string>",
"safari_push_id": "<string>",
"safari_icon_16_16": "<string>",
"safari_icon_32_32": "<string>",
"safari_icon_64_64": "<string>",
"safari_icon_128_128": "<string>",
"safari_icon_256_256": "<string>",
"site_name": "<string>"
}
]{
"errors": [
"This API endpoint is disabled for organizations with over 1000 apps. Please contact support if you need access to this endpoint."
]
}{
"errors": [
"You do not have permission to list apps."
]
}{
"errors": [
"API rate limit exceeded"
]
}{
"errors": [
"Service temporarily unavailable"
]
}View apps
Retrieve a list of all OneSignal apps associated with your account, including key app details like name, App ID, subscription counts, and timestamps. Useful for managing multiple apps through the OneSignal API.
curl --request GET \
--url https://api.onesignal.com/apps \
--header 'Authorization: <authorization>'import Onesignal from '@onesignal/node-onesignal';
const configuration = Onesignal.createConfiguration({
organizationApiKey: 'YOUR_ORGANIZATION_API_KEY',
});
const apiInstance = new Onesignal.DefaultApi(configuration);
try {
const response = await apiInstance.getApps();
console.log(response);
} catch (e) {
if (e instanceof Onesignal.ApiException) {
// `e.errorMessages` flattens any error-envelope shape to a `string[]`;
// the raw parsed body remains on `e.body`.
console.error("getApps failed: HTTP " + e.code, e.errorMessages);
} else {
throw e;
}
}import onesignal
from onesignal.api import default_api
from onesignal.models import *
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token for authorization, while others require REST_API_KEY.
# We recommend adding both of them in the configuration page so that you will not need to figure it out yourself.
configuration = onesignal.Configuration(
rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints
organization_api_key = "YOUR_ORGANIZATION_API_KEY" # Organization key is only required for creating new apps and other top-level endpoints
)
# Enter a context with an instance of the API client
with onesignal.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = default_api.DefaultApi(api_client)
# example, this endpoint has no required or optional parameters
try:
# View apps
api_response = api_instance.get_apps()
pprint(api_response)
except onesignal.ApiException as e:
print("Exception when calling DefaultApi->get_apps: %s\n" % e)
print("Status Code: %s" % e.status)
print("Response Body: %s" % e.body)<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: organization_api_key
$config = onesignal\client\Configuration::getDefaultConfiguration()
->setRestApiKeyToken('YOUR_REST_API_KEY')
->setOrganizationApiKeyToken('YOUR_ORGANIZATION_API_KEY');
$apiInstance = new onesignal\client\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
try {
$result = $apiInstance->getApps();
print_r($result);
} catch (\onesignal\client\ApiException $e) {
echo 'Exception when calling DefaultApi->getApps: ', $e->getMessage(), PHP_EOL;
echo 'Status Code: ', $e->getCode(), PHP_EOL;
// getErrorMessages() flattens any error-envelope shape to a string[];
// the raw body remains on getResponseBody().
echo 'Error Messages: ', implode(', ', $e->getErrorMessages()), PHP_EOL;
echo 'Response Body: ', $e->getResponseBody(), PHP_EOL;
} catch (\Exception $e) {
echo 'Exception when calling DefaultApi->getApps: ', $e->getMessage(), PHP_EOL;
}package main
import (
"context"
"fmt"
"os"
"github.com/OneSignal/onesignal-go-api/v5"
)
func main() {
configuration := onesignal.NewConfiguration()
apiClient := onesignal.NewAPIClient(configuration)
orgAuth := context.WithValue(context.Background(), onesignal.OrganizationApiKey, "YOUR_ORGANIZATION_API_KEY") // Organization API key is only required for creating new apps and other top-level endpoints
resp, r, err := apiClient.DefaultApi.GetApps(orgAuth).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.GetApps``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
if apiErr, ok := err.(*onesignal.GenericOpenAPIError); ok {
// ErrorMessages() flattens any error-envelope shape to a []string;
// the raw body remains on Body().
fmt.Fprintf(os.Stderr, "Error Messages: %v\n", apiErr.ErrorMessages())
fmt.Fprintf(os.Stderr, "Response Body: %s\n", apiErr.Body())
}
}
// response from `GetApps`: []App
fmt.Fprintf(os.Stdout, "Response from `DefaultApi.GetApps`: %v\n", resp)
}require 'onesignal'
# setup authorization
OneSignal.configure do |config|
# Configure Bearer authorization: organization_api_key
config.organization_api_key = 'YOUR_ORGANIZATION_API_KEY'
end
api_instance = OneSignal::DefaultApi.new
begin
# View apps
result = api_instance.get_apps
p result
rescue OneSignal::ApiError => e
puts "Error when calling DefaultApi->get_apps: #{e}"
puts "Status Code: #{e.code}"
# `e.error_messages` flattens any error-envelope shape to an Array<String>;
# the raw body remains on `e.response_body`.
puts "Error Messages: #{e.error_messages}"
puts "Response Body: #{e.response_body}"
end// Import classes:
import java.util.List;
import com.onesignal.client.ApiClient;
import com.onesignal.client.ApiException;
import com.onesignal.client.Configuration;
import com.onesignal.client.auth.*;
import com.onesignal.client.model.*;
import com.onesignal.client.api.DefaultApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.onesignal.com");
// Configure HTTP bearer authorization: organization_api_key
HttpBearerAuth organization_api_key = (HttpBearerAuth) defaultClient.getAuthentication("organization_api_key");
organization_api_key.setBearerToken("YOUR_ORGANIZATION_API_KEY");
DefaultApi apiInstance = new DefaultApi(defaultClient);
try {
List<App> result = apiInstance.getApps();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#getApps");
System.err.println("Status code: " + e.getCode());
// getErrorMessages() flattens any error-envelope shape to a List<String>;
// the raw body remains on getResponseBody().
System.err.println("Error messages: " + e.getErrorMessages());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}using System;
using System.Collections.Generic;
using System.Diagnostics;
using OneSignalApi.Api;
using OneSignalApi.Client;
using OneSignalApi.Model;
namespace Example
{
public class GetAppsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.onesignal.com";
// Configure Bearer token for authorization: organization_api_key
config.AccessToken = "YOUR_ORGANIZATION_API_KEY";
var apiInstance = new DefaultApi(config);
try
{
// View apps
List<App> result = apiInstance.GetApps();
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.GetApps: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
// e.ErrorMessages flattens any error-envelope shape to an IReadOnlyList<string>;
// the raw body remains on e.ErrorContent.
Debug.Print("Error Messages: " + string.Join(", ", e.ErrorMessages));
Debug.Print("Response Body: " + e.ErrorContent);
Debug.Print(e.StackTrace);
}
}
}
}use onesignal_rust_api::apis::configuration::Configuration;
use onesignal_rust_api::apis::default_api;
#[tokio::main]
async fn main() {
let mut configuration = Configuration::new();
configuration.organization_api_key_token = Some("YOUR_ORGANIZATION_API_KEY".to_string());
match default_api::get_apps(&configuration).await {
Ok(resp) => println!("{:?}", resp),
Err(e @ onesignal_rust_api::apis::Error::ResponseError(_)) => {
// `e.error_messages()` flattens any error-envelope shape to a Vec<String>;
// the raw response remains on the ResponseError variant.
eprintln!("get_apps failed: {:?}", e.error_messages());
}
Err(e) => eprintln!("get_apps failed: {:?}", e),
}
}[
{
"id": "<string>",
"name": "<string>",
"players": 123,
"messageable_players": 123,
"created_at": "<string>",
"updated_at": "<string>",
"organization_id": "<string>",
"additional_data_is_root_payload": true,
"gcm_key": "<string>",
"fcm_v1_service_account_json": "<string>",
"fcm_sender_id": "<string>",
"chrome_key": "<string>",
"chrome_web_key": "<string>",
"chrome_web_origin": "<string>",
"chrome_web_gcm_sender_id": "<string>",
"chrome_web_default_notification_icon": "<string>",
"chrome_web_sub_domain": "<string>",
"apns_env": "<string>",
"apns_certificates": "<string>",
"apns_p8": "<string>",
"apns_team_id": "<string>",
"apns_key_id": "<string>",
"apns_bundle_id": "<string>",
"safari_apns_certificate": "<string>",
"safari_site_origin": "<string>",
"safari_push_id": "<string>",
"safari_icon_16_16": "<string>",
"safari_icon_32_32": "<string>",
"safari_icon_64_64": "<string>",
"safari_icon_128_128": "<string>",
"safari_icon_256_256": "<string>",
"site_name": "<string>"
}
]{
"errors": [
"This API endpoint is disabled for organizations with over 1000 apps. Please contact support if you need access to this endpoint."
]
}{
"errors": [
"You do not have permission to list apps."
]
}{
"errors": [
"API rate limit exceeded"
]
}{
"errors": [
"Service temporarily unavailable"
]
}Overview
Use this API to retrieve metadata and platform configuration for all OneSignal apps associated with your account. For each app this returns app names, App IDs, subscription counts, timestamps, and the same push platform configuration (Android/FCM, iOS/APNs, Web Push, Safari) returned by View an app — with the exception of the per-app conversion attribution windows andchannels, which are only returned by View an app.
400 error instead of a truncated list. In that case, store the app_id and name for each of your apps on your own server and look them up individually with the View an app API. 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
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. Omitted when view=config is passed.
The number of subscribed web and mobile Subscriptions. These Subscriptions are eligible to receive messages in the app. Omitted when view=config is passed.
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.
When true, custom additional data is sent at the root of the push payload instead of nested under a custom key (iOS only).
Legacy. The deprecated Google Cloud Messaging (GCM/FCM legacy) server API key. Retained for backward compatibility; use fcm_v1_service_account_json instead.
Your FCM Service Account JSON file for Android push notifications. See Android: Firebase Credentials.
The FCM Sender ID associated with your Firebase project.
Legacy. The deprecated Google Chrome extension (GCM) API key. Retained for backward compatibility.
Web push VAPID public key for Chrome web push notifications.
The HTTPS origin URL for your website. Required for web push notifications.
The GCM Sender ID used for web push notifications.
The full HTTPS URL to your default notification icon. Should be a 256x256px PNG.
The OneSignal subdomain for web push if not using your own origin.
The APNS environment: production or development. See iOS SDK Setup.
The APNS p12 certificate for iOS push notifications.
The APNs Auth Key (.p8) token-based credential for iOS push notifications.
The Apple Developer Team ID associated with the APNs Auth Key.
The Key ID of the APNs Auth Key (.p8).
The app bundle ID associated with the APNs Auth Key.
The Safari APNs certificate, or "OneSignal Provided Certificate" when using a OneSignal-managed Safari certificate.
The HTTPS origin URL configured for Safari web push.
The Safari Web Push ID (website push ID / certificate bundle ID).
URL to the 16x16px Safari notification icon.
URL to the 32x32px Safari notification icon.
URL to the 64x64px Safari notification icon.
URL to the 128x128px Safari notification icon.
URL to the 256x256px Safari notification icon.
The name of the website configured for web push.
Was this page helpful?