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 Notifications API

The Notifications API from OneSignal — 4 operation(s) for notifications.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 14 operations across 11 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

14 operations 11 paths 31 schemas 2 DELETE4 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.onesignal.com
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

OneSignal Notifications 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 14

Across 11 paths, the API surfaces 14 operations — 2 DELETE, 4 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Notifications 14
POST
/notifications/{message_id}/history
Message history
message-history 2 params body → 202400429503
POST
/notifications/{message_id}/export_events
Export audience activity CSV
export-csv-of-events 3 params → 200400401404429503
POST
/notifications?c=email
Email
email 1 param body → 200400403429503
POST
/notifications?c=push
Push notification
push-notification 1 param body → 200400403429503
POST
/notifications?c=sms
SMS
sms 1 param body → 200400403429503
GET
/notifications?app_id={app_id}&limit={limit}&offset={offset}&kind={kind}&template_id={template_id}&time_offset={time_offset}
View messages
view-messages 7 params → 200429503
GET
/notifications/{message_id}?app_id={app_id}
View message
view-message 7 params → 200429503
DELETE
/notifications/{message_id}?app_id={app_id}
Cancel message
cancel-message 3 params → 200400404429503
GET
/notifications
View notifications
get_notifications 4 params → 200400429
POST
/notifications
Create notification
create_notification body → 200400429
DELETE
/notifications/{notification_id}
Stop a scheduled or currently outgoing notification
cancel_notification 2 params → 200400404429
GET
/notifications/{notification_id}
View notification
get_notification 2 params → 200400404429
POST
/notifications/{notification_id}/history
Notification History
get_notification_history 1 param body → 200400404429
POST
/notifications/{notification_id}/export_events?app_id={app_id}
Export CSV of Events
export_events 2 params → 200400404429

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are BasicNotification_allOf (102 properties), LanguageStringMap (43 properties), NotificationWithMeta_allOf (14 properties), SubscriptionNotificationTarget (11 properties). Each schema is shown below with its type and property counts.

BasicErrorResponse
object
3 properties
FilterExpression
BasicNotification
NotificationWithMeta
NotificationTarget
CreateNotificationSuccessResponse
object
3 properties
RateLimitError
object
2 properties
GenericError
object
3 properties
OutcomeData
object
3 properties 3 required
Operator
object
1 property
PlatformDeliveryData_email_allOf
object
7 properties
DeliveryData
object
5 properties
PlatformDeliveryData
object
Hash of delivery statistics broken out by target device platform.
8 properties
BasicNotification_allOf
object
102 properties
NotificationHistorySuccessResponse
object
2 properties
WebButton
object
4 properties 1 required
SubscriptionNotificationTarget
object
11 properties
ExportEventsSuccessResponse
object
1 property
GenericSuccessBoolResponse
object
1 property
PlatformDeliveryData_sms_allOf
object
3 properties
OutcomesData
object
1 property
SegmentNotificationTarget
object
2 properties
NotificationSlice
object
4 properties
LanguageStringMap
object
43 properties
Button
object
3 properties 1 required
Notification_allOf
object
1 property
Filter
object
8 properties
Notification
get_notification_history_request_body
object
3 properties 1 required
NotificationWithMeta_allOf
object
14 properties
BasicNotification_allOf_android_background_layout
object
Channel: Push Notifications Platform: Android Allowing setting a background image for the notification. This is a JSON object containing the following keys. Se…
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onesignal-notifications-api-openapi.yml Raw ↑

Other APIs OneSignal publishes across the network.

OneSignal Apps 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
OneSignal Organizations API
AE Profile APIs.io
#Notification
← Back to O APIs
API Details
ID
onesignal:onesignal-notifications-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-notifications-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/onesignal-notifications-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 Notifications 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.