GET https://onesignal.com/api/v1/players?app_id={app_id}&limit={limit}&offset={offset}
Parameter | Type | Required | Description |
---|---|---|---|
app_id | string | Yes | Your OneSignal App ID. |
limit | int | No | Number of entries to return (max 300, default is 300). |
offset | int | No | Result offset for pagination. |
Header | Value | Required | Description |
---|---|---|---|
Authorization | Basic YOUR_LEGACY_REST_API_KEY | Yes | Your OneSignal Legacy REST API Key. |
Field | Type | Description |
---|---|---|
total_count | integer | Total number of devices for the app. |
offset | integer | Current pagination offset. |
limit | integer | Number of devices returned in this response. |
players | array | List of device objects. |
players[].id | string | Unique OneSignal player ID. |
players[].identifier | string | Push token, email, or phone number. |
players[].tags | object | Custom tags set on the device. |
players[].external_user_id | string | Your internal user ID. |