GET
/
apps
/
{app_id}
/
subscriptions
/
{subscription_id}
/
user
/
identity
curl --request GET \
  --url https://api.onesignal.com/apps/{app_id}/subscriptions/{subscription_id}/user/identity
"{\n  \"identity\": {\n    \"onesignal_id\": \"27d9de62-4e7b-4809-a856-bf279288bbda\",\n    \"external_id\": \"my-external-id\",\n    \"custom_alias_label\": \"custom_alias_id\"\n  }\n}"

​
Overview

Use this API when you want to find the full identity (all aliases) of a user, starting from a known subscription_id. This is helpful for debugging, reverse lookups, or support use cases where only a subscription record is available.

Unlike the View user identity API which starts with an alias (e.g., external_id), this endpoint works when only a subscription ID is known.

See Subscriptions for background on how subscriptions relate to users.

​
How to use this API

To use this endpoint, you must provide:

  • subscription_id – A UUID generated by OneSignal when a device or channel (e.g., push, email, SMS) is registered.

subscription_id values are immutable and cannot be changed. Make sure you are using the correct value, as they are unique to each app and platform.

Once a valid subscription_id is provided, the API will return the user’s identity object, which includes all associated aliases like external_id, onesignal_id, and any custom aliases.

Path Parameters

​
app_id
string
required

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

​
subscription_id
string
required

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

Response

200
application/json

200

The response is of type object.

GET
/
apps
/
{app_id}
/
subscriptions
/
{subscription_id}
/
user
/
identity
curl --request GET \
  --url https://api.onesignal.com/apps/{app_id}/subscriptions/{subscription_id}/user/identity
"{\n  \"identity\": {\n    \"onesignal_id\": \"27d9de62-4e7b-4809-a856-bf279288bbda\",\n    \"external_id\": \"my-external-id\",\n    \"custom_alias_label\": \"custom_alias_id\"\n  }\n}"

​
Overview

Use this API when you want to find the full identity (all aliases) of a user, starting from a known subscription_id. This is helpful for debugging, reverse lookups, or support use cases where only a subscription record is available.

Unlike the View user identity API which starts with an alias (e.g., external_id), this endpoint works when only a subscription ID is known.

See Subscriptions for background on how subscriptions relate to users.

​
How to use this API

To use this endpoint, you must provide:

  • subscription_id – A UUID generated by OneSignal when a device or channel (e.g., push, email, SMS) is registered.

subscription_id values are immutable and cannot be changed. Make sure you are using the correct value, as they are unique to each app and platform.

Once a valid subscription_id is provided, the API will return the user’s identity object, which includes all associated aliases like external_id, onesignal_id, and any custom aliases.

Path Parameters

​
app_id
string
required

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

​
subscription_id
string
required

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

Response

200
application/json

200

The response is of type object.