Skip to main content
GET
TypeScript

Autorisations

Authorization
string
header
requis

A user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

user:notifications:read

En-têtes

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

id
string
requis

A notification id from List Notifications, or the ephemeral id delivered with a push or websocket event.

Réponse

notification found

account
object | null
requis

Account the notification belongs to. null when the notification is not associated with an account.

attachment_url
string
requis

Image displayed alongside the notification — the sender's avatar, or the default notification image.

Exemple:

"https://ui-avatars.com/api/"

content
string
requis

The body text of the notification displayed to the user.

Exemple:

"Tuesday 9:00 AM, Bay 2"

created_at
string
requis

When the notification was created, as an ISO 8601 timestamp.

Exemple:

"2026-01-01T12:00:00.000Z"

experience
object | null
requis

Experience the notification is related to. null when not tied to a specific experience.

id
string
requis

Notification ID. Feed rows carry a composite id that doubles as the list cursor.

Exemple:

"ntfr_xxxxxxxxxxxxxx:xxxxxxxxxxxxx"

The same destination on the app's own domain, which the Whop web and mobile clients embed instead of navigating to it. Only relevant if you render Whop apps yourself. null when the notification carries its own link.

Exemple:

"https://whopappdomain0000001.apps.whop.com/experiences/exp_xxxxxxxxxxxxxx/bookings/upcoming"

The whop.com page the notification opens, as a normal top-level navigation. This is the link to use unless you host Whop apps yourself. null when the notification has no click-through destination.

Exemple:

"https://whop.com/joined/shine-time-auto-detailing/bookings-xxxxxxxxxxxxxx/app/bookings/upcoming/"

mentions_me
boolean
requis

Whether the authenticated user was directly mentioned in this notification.

Exemple:

false

rest_path
string | null
requis

Additional path information appended to the notification's deep link, if any.

Exemple:

"/bookings/upcoming"

sender
object | null
requis

User who triggered the notification. null when it was system-generated.

subject
string
requis

The title line of the notification displayed to the user.

Exemple:

"Your ceramic coating is booked"

topic
object | null
requis

Topic category the notification belongs to, used for grouping and preference management. null when uncategorized.