Your AI team, working in OneSignal REST API

The OneSignal REST API enables developers to programmatically send push notifications, emails, and SMS, manage users and subscriptions, and configure apps.

Start your company

What your team can do in OneSignal REST API

15 tools to work with, connected with an API key.

Begin Live Activity

Tool to start a Live Activity on OneSignal. Use when you need to initiate a Live Activity session with a push token and subscription ID.

Create Notification

Tool to create and send a OneSignal push notification. Use when you have your message and target audience ready to dispatch notifications.

Create Template

Tool to create reusable message templates for push, email, and SMS channels. Use when you need to create a template that can be accessed through both the dashboard and API using a template_id.

Create User

Create a OneSignal user with optional subscriptions and aliases, or modify subscriptions associated with an existing user. Supplied aliases are used to look up an existing user.

Delete Alias

Tool to delete an alias by alias label from a OneSignal user. Use when you need to remove a specific alias identity from a user's profile.

Delete Device

Tool to delete a device (player) from a OneSignal app. Use when you need to remove a specific device by its player ID.

Fetch User IdentityReads only

Tool to retrieve all aliases for a user identified by a specific alias. Use when you need to fetch the complete identity mapping for a OneSignal user.

Get Eligible In-App MessagesReads only

Tool to retrieve the manifest of In-App Messages that a subscription is eligible to display. Use when you need to fetch eligible IAMs for a specific subscription.

Update Device

Tool to update properties of an existing device. Use when you need to modify device attributes after registration.

Update Subscription

Tool to update an existing subscription's properties. Use when you need to modify subscription attributes like token, enabled status, or device information.

View DeviceReads only

Tool to retrieve details of a specific device (player). Use when you have a OneSignal player_id and need current device info.

View DevicesReads only

Tool to retrieve a paginated list of devices (players) for a OneSignal app. Use when you need to list or audit all registered devices for a given app.

View NotificationsReads only

Tool to retrieve details of multiple notifications. Use when you need to list notifications for a specific app.

View OneSignal AppReads only

Tool to retrieve metadata for a single OneSignal app. Use when you need to fetch app details by its ID.

View SegmentsReads only

List segments associated with a OneSignal app, using limit and offset to page through results.

More in Notifications

See them all β†’

Your company, run by an AI team

Start your company

BRAINER

Continue to B.R.A.I.N.E.R.

Continue with Google or your email.

or