staqlydocs
REST APIAPI referenceAccounts

The signed-in person's notification choices

The signed-in person's notification choices

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

GET
/v1/account/notifications

Per event, whether the person gets an email (to the address they sign in with) and whether it shows in the bell. scope decides which posts: mine (posts they wrote, or their API keys wrote) or all (every post in the workspaces they edit). Channel, schedule and invitation events go to owners and admins. Emails need the server's mail (MAIL_*); mail_ready says whether it is set up.

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Response Body

OK

application/json
  1. response
scope*string
Value in"mine""all"
events*array<>
email*string

Where the emails go (the address the person signs in with)

mail_ready*boolean

The server can send email

curl -X GET 'https://staqly.example.com/v1/account/notifications'
{  "scope": "mine",  "events": [    {      "event": "post.published",      "email": true,      "in_app": true    }  ],  "email": "string",  "mail_ready": true}