Sign in

v1

latestOpenAPI 3.1.02026-07-26497885.9 KB

View user identity

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.

get/apps/{app_id}/users/by/{alias_label}/{alias_id}/identity

Path parameters

app_idstring required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

alias_labelstring required

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.

alias_idstring required

The specific identifier for the given alias to identify the user.

Headers

Authorizationstring required

Your App API key with prefix Key . See Keys & IDs.

Response

200

Example response

{
  "identity": {
    "onesignal_id": "OneSignal-ID-in-UUID-v4-format",
    "external_id": "the-users-external-id"
  }
}