a84d4905fdbb

latestOpenAPI 3.1.02026-08-143874115.7 MB
Notifications

List Notifications

Lists the authenticated user's notifications, newest first. Requires a user credential — an account API key has no notification feed. Without filters the feed spans every experience the user belongs to plus the teams they are a member of.

get/notifications

Query parameters

unreadboolean

Only return notifications created since the user last viewed their source.

experience_idstring

Only return notifications from this experience (exp_ tag).

account_idstring

Only return team notifications for this account (biz_ tag).

mentionsboolean

Only return notifications that mention the user directly.

firstinteger

The number of notifications to return (default 20, max 100).

afterstring

A cursor (a notification id from a previous page); returns notifications older than it.

Response

notifications listed

Example response

{
  "data": [
    {
      "account": {
        "id": "biz_xxxxxxxxxxxxxx",
        "logo_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "route": "shine-time-auto-detailing",
        "title": "Shine Time Auto Detailing"
      },
      "attachment_url": "https://ui-avatars.com/api/",
      "content": "Tuesday 9:00 AM, Bay 2",
      "created_at": "2026-01-01T12:00:00.000Z",
      "experience": {
        "app": {
          "icon_url": "https://pub-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.r2.dev/custom-perk-icon.svg",
          "id": "app_xxxxxxxxxxxxxx"
        },
        "id": "exp_xxxxxxxxxxxxxx",
        "name": "Bookings"
      },
      "id": "ntfr_xxxxxxxxxxxxxx:xxxxxxxxxxxxx",
      "iframe_link": "https://whopappdomain0000001.apps.whop.com/experiences/exp_xxxxxxxxxxxxxx/bookings/upcoming",
      "link": "https://whop.com/joined/shine-time-auto-detailing/bookings-xxxxxxxxxxxxxx/app/bookings/upcoming/",
      "rest_path": "/bookings/upcoming",
      "sender": {
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Tanya Cole",
        "username": "tanyacole"
      },
      "subject": "Your ceramic coating is booked",
      "topic": {
        "default_preference_value": true,
        "id": "topic_xxxxxxxxxxxxxx",
        "topic_type": "user"
      }
    }
  ],
  "page_info": {
    "end_cursor": "ntfr_xxxxxxxxxxxxxx:xxxxxxxxxxxxx",
    "start_cursor": "ntfr_xxxxxxxxxxxxxx:xxxxxxxxxxxxx"
  }
}