OneSignal API (Full)
Browse all Onesignal APIs61
AI ReadinessAI-Aware (B-)61/100
Agent-ready OpenAPI document · curated by JenticCommunicationsPush NotificationsapiKey55 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Manage OneSignal apps, users, subscriptions, segments, templates, and notifications across push, email, and SMS through the full 55-endpoint OneSignal API.
Use for: I want to create a new OneSignal app, Send a push notification across all platforms for an app, Build a segment of users tagged 'premium', Update a user identified by their external alias
Not supported: Does not handle in-product UI personalisation, payments, or CRM contact storage - use for OneSignal app, user, segment, subscription, notification, and outcomes management only.
Jentic publishes the only available OpenAPI specification for OneSignal API (Full), keeping it validated and agent-ready. The full OneSignal API exposes 55 endpoints covering apps, notifications, segments, users, subscriptions, templates, players, organizations, and outcomes analytics. Agents and applications can create and update apps, send notifications across push, email, and SMS channels, manage user records and aliases, build and edit segments, transfer subscription ownership, and pull outcome metrics filtered by attribution, platform, and time range.
Install Jentic One Beta
Connect the OneSignal API (Full) to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the OneSignal API (Full), or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fonesignal.com%2Fonesignal-api" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fonesignal.com%2Fonesignal-api" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with OneSignal API (Full) API.
Create, update, and view OneSignal apps under an organization
Send push, email, and SMS notifications and pull message history
Build, edit, and delete user segments based on tags and properties
Create and update users by alias and manage subscription ownership transfers
Manage subscriptions by id or by token type and token value
Pull outcome analytics filtered by name, time range, platform, and attribution
Export player records to CSV for offline analysis or migration
Use Cases
Patterns agents use OneSignal API (Full) API for, with concrete tasks.
★ Multi-Channel Notification Campaigns
Coordinate push, email, and SMS sends from one API for a marketing campaign and inspect delivery outcomes afterwards. Notifications are created against an app, history can be pulled per message, and outcome analytics reveal conversions broken down by platform and attribution window.
Send a push notification to the 'Lapsed Users' segment under app id 'app-xyz' with heading 'We miss you' and pull the outcomes for 'click' over the next 7 days.
User and Subscription Management
Manage end-user identities through OneSignal aliases, link multiple device subscriptions to a single user, and transfer ownership when a subscription moves between accounts. POST /apps/{app_id}/users creates the user; PATCH endpoints update aliases and subscription assignments.
Create a user under app 'app-xyz' with external_id 'cust-123' and attach an existing iOS subscription id to that user.
Segmentation for Targeted Messaging
Define audience segments inside OneSignal programmatically based on tags or user properties, then reuse those segments when creating notifications. POST /apps/{app_id}/segments creates the segment, PATCH updates it, and DELETE removes it when no longer needed.
Create a segment named 'Active iOS Premium' under app 'app-xyz' filtered to platform=iOS and tag plan=premium.
Outcome and Conversion Analytics
Pull outcome metrics with platform and attribution filters to evaluate campaign performance after a send. GET /apps/{app_id}/outcomes accepts outcome names, a time range, platforms, and attribution windows, returning aggregate counts ready for reporting dashboards.
Pull outcome metrics for 'os__click' on app 'app-xyz' for the last 7 days filtered to iOS with direct attribution.
Agent-Run OneSignal Operations via Jentic
Customer engagement and marketing-ops agents drive OneSignal end to end through Jentic - sending notifications, editing segments, transferring subscriptions, and pulling outcomes - without ever holding the REST API key. Agents search by intent, load the matching schema, and execute against the OneSignal endpoint.
Use Jentic search 'create onesignal segment' to locate POST /apps/{app_id}/segments, load the schema, and execute with the segment definition.
Key Endpoints
55 endpoints — jentic publishes the only available openapi specification for onesignal api (full), keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/apps
Create a OneSignal app
GET
/apps
List apps under the organization
POST
/apps/{app_id}/segments
Create a user segment
POST
/apps/{app_id}/users
Create a user
PATCH
/apps/{app_id}/subscriptions/{subscription_id}/owner
Transfer a subscription to another user
GET
/apps/{app_id}/outcomes
Retrieve outcome analytics with filters
POST
/players/csv_export
Export player records to CSV
POST
/notifications/{message_id}/history
Retrieve message history for a notification
POST
/apps
Create a OneSignal app
GET
/apps
List apps under the organization
POST
/apps/{app_id}/segments
Create a user segment
POST
/apps/{app_id}/users
Create a user
PATCH
/apps/{app_id}/subscriptions/{subscription_id}/owner
Transfer a subscription to another user
GET
/apps/{app_id}/outcomes
Retrieve outcome analytics with filters
POST
/players/csv_export
Export player records to CSV
POST
/notifications/{message_id}/history
Retrieve message history for a notification
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
A
api.onesignal.com
- AI-Aware (B-)61/100
46
Foundational Compliance63
Developer Experience & Jentic Compatibility44
AI-Readiness & Agent Experience93
Agent Usability100
Security75
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
46
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: DSignals: 4
85%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
0%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: BSignals: 4
16%
Example Density
How richly the API is illustrated with examples.
90%
Example Validity
Percentage of examples that conform to their schemas.
47%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
44
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: DSignals: 4
50%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
96%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
29%
Summary Coverage
Coverage of summaries across operations/tags/info.
93
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
93%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
100
Security
Trust, risk posture, and security compliance.
Grade: A+Signals: 1
100%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
75
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A-Signals: 1
75%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the full OneSignal API by hand means managing its REST API key and building calls across 55 endpoints for apps, users, segments, subscriptions, and outcomes against api.onesignal.com yourself. Through Jentic you install once, import the OneSignal API from the API Directory, store the key once, and your agent calls it.
Permission scoping
OneSignal puts the app id in the URL path (/apps/{app_id}/segments, /apps/{app_id}/users), so a rule can pin your agent to one app: it can manage segments and users for that app and nothing else. You choose the operations it may call, so creating apps or exporting players are not included unless you add them.
Credential isolation
Your OneSignal REST API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create a onesignal segment' or 'add a onesignal user', and Jentic returns the matching OneSignal operation across the 55-endpoint surface with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using OneSignal API (Full) API through Jentic.
Why is there no official OpenAPI spec for OneSignal API (Full)?
OneSignal does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call OneSignal API (Full) via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the OneSignal API (Full) use?
The API uses an apiKey credential - the OneSignal REST API Key sent in the Authorization header. Through Jentic the key is held encrypted in the vault (your Jentic One instance) and the agent only sees a scoped reference.
Can I manage OneSignal segments programmatically?
Yes. POST /apps/{app_id}/segments creates a segment, GET lists segments, PATCH updates an existing segment, and DELETE removes it. Segments can then be referenced when sending notifications.
How do I transfer a subscription between users?
Use PATCH /apps/{app_id}/subscriptions/{subscription_id}/owner with the target user's identity. The endpoint reassigns the subscription so future activity is attributed to the new owner.
Does the OneSignal API expose outcome analytics?
Yes. GET /apps/{app_id}/outcomes returns aggregated counts for named outcomes filtered by time range, platform, and attribution window, suitable for campaign reporting.
What are the rate limits for the OneSignal API (Full)?
Rate limits are not declared in this OpenAPI spec. Consult documentation.onesignal.com for the current REST API limits, which differ by endpoint family.
How do I run a OneSignal segment update through Jentic?
Run pip install jentic, search 'update onesignal segment', then load the PATCH /apps/{app_id}/segments/{segment_id} schema and execute. Jentic injects the REST API key from its vault.
Can I limit what my agent is allowed to do with the OneSignal API?
Yes. Because you run Jentic One yourself, your own rules decide which OneSignal operations and credentials the agent may use. OneSignal carries the app id in the URL path, such as /apps/{app_id}/segments and /apps/{app_id}/users, so a rule can pin the agent to a single app and let it manage only that app's segments and users. You also choose the exact operations it can call, so actions like creating apps or exporting player records stay off limits unless you add them.
GET STARTED