View players
GET https://onesignal.com/api/v1/players?app_id={app_id}&limit={limit}&offset={offset}
Retrieve up to 80,000 player records (Subscriptions) registered to a specific OneSignal app.
This is a Legacy API. Use View User or CSV Export API instead.
Query Parameters
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. |
Headers
Header | Value | Required | Description |
---|---|---|---|
Authorization | Basic YOUR_LEGACY_REST_API_KEY | Yes | Your OneSignal Legacy REST API Key. |
Example Request
Example Response
Response Fields
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. |
Errors
- 400 Bad Request – Invalid query parameters.
- 401 Unauthorized – Invalid or missing API key.
- 403 Forbidden – Access not allowed for this app or key.