Sign in
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. The after cursor is a notification id from a previous response; subsequent pages contain older notifications.

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

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

Changed in 4 of the 74 revisions of this API.116

  • ff3a7657356311See the full diff
    • ▲

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

      request-parameter-default-value-added

    • ●

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

      request-parameter-max-set

  • f1020c3ecda43See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • bdd0e2c70d581See the full diff
    • ○

      the security scope user:notifications:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 099fdc3be4222See the full diff
    • ○

      endpoint added

      endpoint-added

    • ○

      added the new optional header request parameter Api-Version-Date to all path's operations

      new-optional-request-default-parameter-to-existing-path

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.