View a user, including aliases, properties, and subscriptions
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.
Retrieve the current state of a user, identified by the alias_label
and alias_id
in the path parameters. The response will contain all user properties, aliases, and subscriptions belonging to this user.
onesignal_id
can be used as a special alias_label
, using the string "onesignal_id"
as the alias_label
and the UUID as the alias_id
.