OneSignal Store Settings

Returns all OneSignal push-notification settings for the store where the partner app is installed.

This endpoint is hard-scoped to the one_signal settings namespace. The namespace cannot be changed using query parameters or request body fields. No other store settings can be read through this endpoint.

The target store is resolved from the OAuth access token. There is no store ID in the URL.

🔑Scopes

third_one_signal_write - OneSignal Notifications

Note

This scope covers both reading and writing OneSignal settings.

Tokens issued before this scope was granted will receive 403 Forbidden until the store re-authorizes the app.

Behavior

Returns all settings stored under the one_signal namespace for the store.

If the store does not have any OneSignal settings yet, the endpoint returns an empty payload array.

Important

This endpoint only reads settings under the one_signal namespace.

The namespace is fixed server-side and cannot be changed.

The store is resolved from the OAuth access token.
No store ID is required in the URL.

{ "status": "object", "payload": [ { "id": 1024551, "code": "one_signal", "key": "app_id", "value": "8a3f1c2e-..." }, { "id": 1024552, "code": "one_signal", "key": "app_key", "value": "os_v2_app_..." }, { "id": 1024553, "code": "one_signal", "key": "android_package_name", "value": "sa.zid.store" }, { "id": 1024554, "code": "one_signal", "key": "ios_app_id", "value": "1234567890" } ] }

OneSignal Store Settings

Note

Important

Request

Responses

OneSignal Store Settings

Note#

Important#

Request

Responses

Note

Important