Retrieve aliases associated with a user with a known subscription. This API is handy for scenarios where the alias is unknown, but the subscription (or Player ID) is available.

How to Use this API

The response body contains an object with key-value pairs for each alias label and ID associated with the user. This includes the OneSignal ID, which can be accessed via the identity.onesignal_id property.


Path Parameters

subscription_id

Description

The unique identifier that represents a subscription in our system. The owner of the subscription will be returned if it matches.

Guidance

  • You may use the Player ID since it's equivalent to a subscription.

Language