List the caller's notifications
/v1/me/notifications in the Notifications API.
curl "https://api.subscriby.net/v1/me/notifications?unread=1&class=support" \ -H "Authorization: Bearer $SUBSCRIBY_TOKEN"Newest first, paginated with page and per_page like every list. unread=1 narrows to entries not yet read (unread=0 to the ones already read); class narrows to one class; q to entries whose title or body contains the words.
classis the alert class the creator routes on Settings → Notifications:sales,support,recovery,billing,security,passesoronboarding;class_labelis its name in the creator's language.titleandbodyare the alert's heading and one sentence of context, the same words the email used, in the creator's language at the time it was sent.routeandparamsname the dashboard screen the entry opens, as a named route and its parameters, for a client that maps routes to screens;urlis the same place resolved, for a client that does not. All three arenullwhen the alert points nowhere.readis whether the creator opened it;read_atsays when.
Every creator alert is written to the notification centre beside whatever else it sends (the email, the message on a connected account the creator routed it to on Settings → Notifications). The entry is shaped from the alert's email: its subject becomes the title, its first line the body, its call to action the route and URL. There is no webhook for a new entry; the alerts that matter to an integration already fire their own events (recovery.*, connector.*, support.*), and a Zap that wants the inbox itself polls the notification_received trigger.
Requires ability
The token must hold this ability, or the call is refused with 403.
MCP tool
Runs the same action from an agent, behind the same ability.
Authorization
bearerToken A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.
In: header
Query Parameters
1 narrows to entries not yet read, 0 to the ones already read; omit it for both.
Narrow to one alert class: sales, support, recovery, billing, security, passes or onboarding. An unknown class is refused.
Words the title or body must contain, up to 120 characters.
length <= 120The 1-based page to return. A page past the last answers an empty data array with meta.total still filled, so a loop can stop without guessing.
1 <= value1Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 15.
1 <= value <= 10015The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.
"created_at"asc or desc. Defaults to desc.
"desc"Value in
- "asc"
- "desc"
Responses
200OKapplication/json
The page, newest first.
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.
422Validation failedVALIDATION_FAILEDapplication/json
The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with error.message saying why and no fields.
On this endpoint: VALIDATION_FAILED: when class is not one of the seven classes.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on
Notifications API
Every alert Subscriby sends a creator (a sale, a support backlog, a bot or channel that went silent, a billing or security notice, a pass window, an onboarding nudge) also lands in the Notifications Center: the sidebar entry with its unread count and popover, and the page at /notifications.
Mark every notification read
/v1/me/notifications/read-all in the Notifications API.