Overview

The Fetch Identity endpoint retrieves all aliases associated with a user using a known alias.


How to Use this API

The response body contains an object with key-value pairs for each alias label and ID associated with the user. This includes the OneSignal ID, which can be accessed via the identity.onesignal_id property.

Examples

Fetch user identity

curl "https://api.onesignal.com/apps/<APP_ID>/users/by/<ALIAS_LABEL>/<ALIAS_ID>/identity"


Path Parameters

alias_label

Description

The name of the alias to use to fetch a user. All users include a special OneSignal ID alias named onesignal_id.

Guidance

  • We recommend fetching users via your identifier using the External ID alias: external_id.
  • Refer to our guide on Aliases & External ID for further details.

alias_id

Description

The specific identifier for a given Alias to identify the user.

Guidance

Quick Start API Guide


Language