# OneSignal REST API

**Canonical:** https://apis.io/apis/onesignal/onesignal-rest-api/  
**Provider:** OneSignal — https://apis.io/providers/onesignal/  
**Base URL:** https://api.onesignal.com  
**Documentation:** https://documentation.onesignal.com/reference

OneSignal REST API is one of 6 APIs that [OneSignal](https://apis.io/providers/onesignal/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Notification, User, Subscription, Segments, and Templates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

The complete OneSignal REST API as OneSignal publishes it — OpenAPI 3.1.0, info.version 11.6, 39 paths and 59 operations covering messaging, users, subscriptions, segments, templates, custom events, inbox, exports, apps, API keys and audit logs. Harvested verbatim from https://documentation.onesignal.com/openapi.json on 2026-08-13; servers[] names https://api.onesignal.com.

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/onesignal/refs/heads/main/openapi/_original/onesignal-api-openapi.json
- **Documentation** — https://documentation.onesignal.com/reference
- **APIReference** — https://documentation.onesignal.com/reference/rest-api-overview
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/onesignal/refs/heads/main/data-model/onesignal-data-model.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/onesignal/refs/heads/main/errors/onesignal-problem-types.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/onesignal/refs/heads/main/conventions/onesignal-conventions.yml
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/onesignal/refs/heads/main/authentication/onesignal-authentication.yml
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/onesignal/refs/heads/main/apis.yml

## Other OneSignal APIs (5)

- [OneSignal Apps API](https://apis.io/apis/onesignal/onesignal-apps-api/)
- [OneSignal Notifications API](https://apis.io/apis/onesignal/onesignal-notifications-api/)
- [OneSignal Players API](https://apis.io/apis/onesignal/onesignal-players-api/)
- [OneSignal Templates API](https://apis.io/apis/onesignal/onesignal-templates-api/)
- [OneSignal MCP Server](https://apis.io/apis/onesignal/onesignal-mcp/)

## Tags

Notification, User, Subscription, Segments, Templates, Messaging

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/onesignal/onesignal-rest-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/onesignal/.