Sign in

v1

latestOpenAPI 3.1.02026-07-26497885.9 KB

View user identity (by subscription)

Retrieve all aliases linked to a user using a known subscription_id. This is useful when the user’s identity is unknown but you have access to one of their push, email, or SMS subscriptions.

get/apps/{app_id}/subscriptions/{subscription_id}/user/identity

Path parameters

app_idstring required

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

subscription_idstring required

The unique Subscription ID in UUID v4 format generated by OneSignal. See Subscriptions.

Response

200

Example response

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