API referenceNotifications

What we notify about

Absent means on. An event with no row is enabled on both channels — a business that has never opened this screen should still hear that a payout failed, so the useful default cannot require a row to exist.

GET
/api/b/v1/notifications/settings

Absent means on.

An event with no row is enabled on both channels — a business that has never opened this screen should still hear that a payout failed, so the useful default cannot require a row to exist.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Query Parameters

mine?Mine

Your overrides rather than the defaults.

Defaultfalse
admin_access_token?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/notifications/settings"
{  "settings": [    {      "event": "string",      "email_enabled": true,      "in_app_enabled": true,      "scope": "string"    }  ],  "known_events": [    "string"  ]}