OneSignal

OneSignal Apps API

The Apps API from OneSignal — 21 operation(s) for apps.

GitHub OpenAPI

Operations 42

GET /apps View apps #
POST /apps Create an app #
GET /apps/{app_id} View an app #
PUT /apps/{app_id} Update an app #
POST /apps/{app_id}/segments Create segment #
GET /apps/{app_id}/segments View segments #
GET /apps/{app_id}/segments/{segment_id} View segment #
PATCH /apps/{app_id}/segments/{segment_id} Update segment #
DELETE /apps/{app_id}/segments/{segment_id} Delete segment #
GET /apps/{app_id}/outcomes?outcome_names={outcome_names}&outcome_time_range={outcome_time_range}&outcome_platforms={outcome_platforms}&outcome_attribution={outcome_attribution} View outcomes #
PATCH /apps/{app_id}/subscriptions/{subscription_id} Update subscription #
DELETE /apps/{app_id}/subscriptions/{subscription_id} Delete subscription #
PATCH /apps/{app_id}/subscriptions_by_token/{token_type}/{token} Update subscription By Token #
POST /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions Create Subscription by alias #
PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id} Update user #
GET /apps/{app_id}/users/by/{alias_label}/{alias_id} View user #
DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id} Delete user #
POST /apps/{app_id}/users Create user #
GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity View user identity #
PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity Create or update alias #
PATCH /apps/{app_id}/subscriptions/{subscription_id}/owner Transfer subscription #
GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity View user identity (by subscription) #
PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity Create alias (by subscription) #
DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete} Delete alias #
POST /apps/{app_id}/notifications/{notification_id}/unsubscribe?token={token} Unsubscribe email (with token) #
POST /apps/{app_id}/live_activities/{activity_id}/notifications Update Live Activity #
POST /apps/{app_id}/activities/activity/{activity_type} Start Live Activity #
POST /apps/{app_id}/inbox Create inbox broadcast message #
GET /apps/{app_id}/inbox?last_broadcast_id={broadcast_id}&limit={number} View broadcasts #
GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/inbox?last_message_id={message_id} View user broadcasts #
PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/inbox?last_message_id={message_id} Bulk update or delete message state #
GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/inbox/unread_count View user unread message count #
PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/inbox/{message_id} Update message state #
GET /apps/{app_id}/auth/tokens View API keys #
POST /apps/{app_id}/auth/tokens Create API key #
DELETE /apps/{app_id}/auth/tokens/{token_id} Delete API key #
PATCH /apps/{app_id}/auth/tokens/{token_id} Update API key #
POST /apps/{app_id}/auth/tokens/{token_id}/rotate Rotate API key #
POST /apps/{app_id}/custom_events Create Custom Events #
GET /apps/{app_id}/outcomes View Outcomes #
POST /apps/{app_id}/notifications/{notification_id}/unsubscribe Unsubscribe with token #
POST /apps/{app_id}/integrations/custom_events Create custom events #

Documentation

📖
Documentation
https://documentation.onesignal.com/reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/onesignal/refs/heads/main/openapi/onesignal-apps-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/onesignal/refs/heads/main/overlays/onesignal-apps-overlay.yaml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/onesignal/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/onesignal-apps-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

onesignal-apps-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Onesignal Apps API
  version: '1.0'
  description: 'Operations tagged Apps across 2 of this provider''s published API definitions: onesignal-api-openapi.json, onesignal-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.onesignal.com
tags:


# --- truncated at 32 KB (701 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onesignal/refs/heads/main/openapi/onesignal-apps-api-openapi.yml