How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
OneSignal

OneSignal Apps API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

OneSignal Apps API is one of 6 APIs that OneSignal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Application. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 31 operations across 21 paths, and defines 41 schemas. It is described by OpenAPI 3.0.0, at version 5.5.0.

Requests are made against a single base URL, https://api.onesignal.com.

31 operations 21 paths 41 schemas 5 DELETE8 GET7 PATCH10 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
5.5.0
Base URL
https://api.onesignal.com
Authentication
HTTP Bearer, HTTP Bearer
Contact
OneSignal DevRel
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

OneSignal Apps API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (rest_api_key). It accepts HTTP bearer tokens (organization_api_key).

Paths & Operations 31

Across 21 paths, the API surfaces 31 operations — 5 DELETE, 8 GET, 7 PATCH, 10 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Apps 31
GET
/apps
View apps
get_apps → 200400429
POST
/apps
Create an app
create_app body → 200400429
GET
/apps/{app_id}
View an app
get_app 1 param → 200400429
PUT
/apps/{app_id}
Update an app
update_app 1 param body → 200400429
GET
/apps/{app_id}/segments
Get Segments
get_segments 3 params → 201400429
POST
/apps/{app_id}/segments
Create Segment
create_segment 1 param body → 201400409429
DELETE
/apps/{app_id}/segments/{segment_id}
Delete Segment
delete_segment 2 params → 200400404429
GET
/apps/{app_id}/outcomes
View Outcomes
get_outcomes 6 params → 200400429
POST
/apps/{app_id}/activities/activity/{activity_type}
Start Live Activity
start_live_activity 2 params body → 201400429
POST
/apps/{app_id}/live_activities/{activity_id}/notifications
Update a Live Activity via Push
update_live_activity 2 params body → 200400429
POST
/apps/{app_id}/users
Creates a User, optionally Subscriptions owned by the User as well as Aliases. Aliases provided in the payload will be used to look up an existing User.
create_user 1 param body → 200201202400409429
DELETE
/apps/{app_id}/users/by/{alias_label}/{alias_id}
Removes the User identified by (:aliaslabel, :aliasid), and all Subscriptions and Aliases
delete_user 3 params → 200400409429
GET
/apps/{app_id}/users/by/{alias_label}/{alias_id}
Returns the User’s properties, Aliases, and Subscriptions.
get_user 3 params → 200400404429
PATCH
/apps/{app_id}/users/by/{alias_label}/{alias_id}
Updates an existing User’s properties.
update_user 3 params body → 202400409429
GET
/apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
Lists all Aliases for the User identified by (:aliaslabel, :aliasid).
get_aliases 3 params → 200400404429
PATCH
/apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
Upserts one or more Aliases to an existing User identified by (:aliaslabel, :aliasid).
create_alias 3 params body → 200400404409429
DELETE
/apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete}
Deletes an alias by alias label
delete_alias 4 params → 200400404409429
POST
/apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions
Creates a new Subscription under the User provided. Useful to add email addresses and SMS numbers to the User.
create_subscription 3 params body → 201202400404409429
DELETE
/apps/{app_id}/subscriptions/{subscription_id}
Deletes the Subscription.
delete_subscription 2 params → 202400404409429
PATCH
/apps/{app_id}/subscriptions/{subscription_id}
Updates an existing Subscription’s properties.
update_subscription 2 params body → 200400404409429
GET
/apps/{app_id}/subscriptions/{subscription_id}/user/identity
Lists all Aliases for the User identified by :subscriptionid.
get_aliases_by_subscription 2 params → 200400404
PATCH
/apps/{app_id}/subscriptions/{subscription_id}/user/identity
Upserts one or more Aliases for the User identified by :subscriptionid.
create_alias_by_subscription 2 params body → 200400404409429
PATCH
/apps/{app_id}/subscriptions/{subscription_id}/owner
Transfers this Subscription to the User identified by the identity in the payload.
transfer_subscription 2 params body → 200400404409429
PATCH
/apps/{app_id}/subscriptions_by_token/{token_type}/{token}
Update subscription by token
update_subscription_by_token 3 params body → 202400404
POST
/apps/{app_id}/notifications/{notification_id}/unsubscribe
Unsubscribe with token
unsubscribe_email_with_token 3 params → 202400429
GET
/apps/{app_id}/auth/tokens
View API keys
view_api_keys 1 param → 200400
POST
/apps/{app_id}/auth/tokens
Create API key
create_api_key 1 param body → 200400
DELETE
/apps/{app_id}/auth/tokens/{token_id}
Delete API key
delete_api_key 2 params → 200400
PATCH
/apps/{app_id}/auth/tokens/{token_id}
Update API key
update_api_key 2 params body → 200400
POST
/apps/{app_id}/auth/tokens/{token_id}/rotate
Rotate API key
rotate_api_key 2 params → 200400
POST
/apps/{app_id}/integrations/custom_events
Create custom events
create_custom_events 1 param body → 200400401429

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are LanguageStringMap (43 properties), App (34 properties), Subscription (17 properties), StartLiveActivityRequest (16 properties). Each schema is shown below with its type and property counts.

CreateUserConflictResponse_errors_inner
object
3 properties
PropertiesBody
object
1 property
UpdateLiveActivityRequest
object
9 properties 3 required
CreateApiKeyResponse
object
2 properties
UpdateApiKeyRequest
object
3 properties
StartLiveActivityRequest
object
16 properties 7 required
User
object
3 properties
CustomEventsResponse
object
LanguageStringMap
object
43 properties
GenericError
object
3 properties
UserIdentityBody
object
1 property
Segment
object
3 properties 2 required
CreateUserConflictResponse
object
1 property
ApiKeyTokensListResponse
object
1 property
CreateSegmentConflictResponse
object
2 properties
Purchase
object
4 properties 3 required
FilterExpression
PropertiesObject
object
11 properties
UpdateLiveActivitySuccessResponse
object
1 property
RateLimitError
object
2 properties
StartLiveActivitySuccessResponse
object
1 property
Subscription
object
17 properties
ApiKeyToken
object
6 properties
GenericSuccessBoolResponse
object
1 property
PropertiesDeltas
object
3 properties
Operator
object
1 property
SegmentData
object
7 properties
CreateSegmentSuccessResponse
object
2 properties
CreateUserConflictResponse_errorsItems_meta
object
1 property
SubscriptionBody
object
1 property
CustomEvent
object
5 properties 1 required
OutcomeData
object
3 properties 3 required
TransferSubscriptionRequestBody
object
1 property
UpdateUserRequest
object
3 properties
GetSegmentsSuccessResponse
object
4 properties
Filter
object
8 properties
OutcomesData
object
1 property
Apps
array
CreateApiKeyRequest
object
3 properties
App
object
34 properties
CustomEventsRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onesignal-apps-api-openapi.yml Raw ↑

Other APIs OneSignal publishes across the network.

OneSignal REST API
AE Profile APIs.io
OneSignal Notifications API
AE Profile APIs.io
OneSignal Players API
AE Profile APIs.io
OneSignal Templates API
AE Profile APIs.io
OneSignal MCP Server
AE Profile APIs.io
#Application
← Back to O APIs
API Details
ID
onesignal:onesignal-apps-api
Base URL
https://api.onesignal.com
Docs
https://documentation.onesignal.com/reference
Provider
OneSignal
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=onesignal-apps-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/onesignal-apps-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of OneSignal Apps API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.