You're Viewing User Model Beta Documentation 🎉

OneSignal is in the process of migrating from a device-centric model (player ID) to a new user-centric data model (OneSignal ID). In the new user-centric world, Users have a OneSignal ID, and what was the player ID is now known as the Subscription ID.

To learn more, check out the User Model Beta Overview.

Please refer to Version 9 of our documentation for device-centric information.

The Fetch Identity endpoint is used to read the onesignal_id and all aliases for a given user. The alias_label and alias_id path parameters are used to identify the User.

The response body will contain identity, an IdentityObject that contains onesignal_id, a UUID, and a key-value dictionary of each alias_label and alias_id that is set on the given user.

You may pass onesignal_id as a special alias to identify the User in the path parameters.