Notifications

List Notifications

Changed on

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

get/notifications

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/notifications
  • Auth: HTTP bearer

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

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

Response

notifications listed

Example response

{
  "data": [
    {
      "account": {
        "id": "biz_xxxxxxxxxxxxxx",
        "logo_url": "https://whop-assets-example.s3.amazonaws.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"
  }
}

Changes

  • ff3a76573563Revision changes
    • breaking

      for the query request parameter first, default value 20 was added

    • warning

      for the query request parameter first, the max was set to 100.00

  • f1020c3ecda4Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status