API referenceNotifications

Your notifications

Scoped to the caller, always. There is no parameter for whose inbox to read. A notification is addressed to a person, and an endpoint that could be pointed at somebody else's would hand any member the finance team's mail.

GET
/api/b/v1/notifications

Scoped to the caller, always.

There is no parameter for whose inbox to read. A notification is addressed to a person, and an endpoint that could be pointed at somebody else's would hand any member the finance team's mail.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Query Parameters

unread_only?Unread Only
Defaultfalse
limit?Limit
Range1 <= value <= 200
Default50
admin_access_token?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/notifications"
{  "notifications": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "event": "string",      "subject": "string",      "body": "string",      "link": "string",      "read_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "unread": 0}

Change a preference PUT

Set one event's channels, for the business or for yourself. Anyone may silence their own mail. Changing what the *business* hears is `NOTIFICATION_MANAGE`, because switching off payout failures for everybody is a decision with consequences for people who did not make it.

Mark notifications read POST

Next Page