v1
latestOpenAPI 3.1.02026-07-26497885.9 KBView user
Retrieve a user including aliases, properties, and subscriptions.
get/apps/{app_id}/users/by/{alias_label}/{alias_id}
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
{
"properties": {
"tags": {
"KEY": "VALUE"
},
"country": "US",
"first_active": 1673449251,
"last_active": 1678126124,
"test_user_name": "QA Device - Jane"
},
"identity": {
"external_id": "example123",
"onesignal_id": "ONESIGNAL_ID"
}
}