API reference

Notifications API

Each person's own notification preferences, with the defaults filled in for anything they never set.

Endpoints

2 operations, each with its parameters, schemas and an example request on its own page.

Authentication

Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.

Objects returned

The models these endpoints send back, with every field. Open one to read it.

PreferencesOut2 fields
  • emailstringrequired
  • preferencesarray of PreferenceOutrequired
    4 fields · PreferenceOut
    • categorystringrequired
    • descriptionstringrequired
    • enabledbooleanrequired
    • labelstringrequired

Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.

Building on it? Start on the free plan — no card — and call the same API the dashboard uses.

Start free