Notifications

List the caller's notifications

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.

  • class is the alert class the creator routes on Settings → Notifications: sales, support, recovery, billing, security, passes or onboarding; class_label is its name in the creator's language.
  • title and body are 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.
  • route and params name the dashboard screen the entry opens, as a named route and its parameters, for a client that maps routes to screens; url is the same place resolved, for a client that does not. All three are null when the alert points nowhere.
  • read is whether the creator opened it; read_at says 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.

get/v1/me/notifications

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/me/notifications
  • Auth: HTTP bearer

Query parameters

unreadboolean nullable

1 narrows to entries not yet read, 0 to the ones already read; omit it for both.

class'sales' | 'support' | 'recovery' | 'billing' | 'security' | 'passes' | 'onboarding' | 'partner' | 'retention'

The families a creator's notifications fall into, for routing. A creator picks where each class goes; the router reads their alert destinations by class. The critical classes always also go out by email, whatever the creator picked, because they are the ones that arrive when the connector the creator would otherwise read them on has just failed.

Narrow to one alert class: sales, support, recovery, billing, security, passes or onboarding. An unknown class is refused.

qstring nullable

Words the title or body must contain, up to 120 characters.

pageinteger

The 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.

per_pageinteger

Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 15.

sort_bystring

The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.

sort_direction'asc' | 'desc'

asc or desc. Defaults to desc.

Response

The page, newest first.

Example response

{
  "data": [
    {
      "id": "0b1f6e2a-7c3d-4e5f-8a9b-0c1d2e3f4a5b",
      "class": "support",
      "class_label": "Support",
      "title": "Support backlog in Signals",
      "body": "Three members are waiting for an answer.",
      "route": "projects.inbox",
      "url": "https://app.subscriby.net/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/inbox",
      "created_at": "2026-09-12T10:05:30Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.