Retrieve all aliases associated with a user using a known alias, such as an external_id
, onesignal_id
, or a custom alias. This API helps you map back to a user’s full identity from any one piece of identifying information.
identity
object—not subscriptions or properties.
alias_label
– the type of alias you’re using to find the user (e.g. external_id
, onesignal_id
, or a custom alias)alias_id
– the actual value of that aliasexternal_id
(recommended):
alias_label
: external_id
alias_id
: your user ID (e.g., user-123)onesignal_id
:
alias_label
: onesignal_id
alias_id
: the OneSignal-assigned unique IDshopify_customer_id
) and its valueexternal_id
as your primary user identifier for portability and simplicity across your systems.Your App API key with prefix Key
. See Keys & IDs.
Your OneSignal App ID in UUID v4 format. See Keys & IDs.
The alias name or key to locate the user. Most commonly set as external_id
but can be the onesignal_id
or a custom alias.
The specific identifier for the given alias to identify the user.
200
The response is of type object
.