Retrieve all aliases associated with a user using a known alias.
Overview
Use this API to lookup all aliases associated with a user when you only know at least one of those aliases like the external_id
, onesignal_id
, or a custom alias. This is similar to the View user API but only returns the identity
object.
If you only know a subscription_id
associated with the user, use the View user identity (by subscription) API.
For details on OneSignal ID and External ID, see Users. For custom aliases, see Aliases.
How to use this API
In most cases, you will use your external_id
as the alias_label
and the value of that ID in the alias_id
. You an also use custom Aliases but we highly recommend setting the external_id
as your main user ID.
To look up a user via OneSignal ID, use onesignal_id
as the alias_label
.