> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Overview: https://docs.whop.com/cli/overview.md Agent mode: https://docs.whop.com/cli/agent-mode.md
> Hosting: Whop serves a site or app from the build `whop apps deploy` uploads, with rollbacks, secrets, and server logs. Guide: https://docs.whop.com/developer/websites/hosting.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Guide: https://docs.whop.com/developer/guides/plugins/claude-code.md Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Sandbox guide: https://docs.whop.com/developer/guides/sandbox.md Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# API Notifications

> Une Notification est un message remis à un utilisateur, comme une nouvelle publication, un paiement ou une mention.

Chacune provient d'une expérience à laquelle l'utilisateur appartient ou d'une équipe dont il fait partie, et relève d'un sujet, comme les nouvelles ventes, pour lequel les utilisateurs définissent des préférences.

Utilisez l'API Notifications pour lister le fil d'un utilisateur, lire et effacer les badges non lus, envoyer des notifications depuis votre app aux utilisateurs d'une expérience ou à l'équipe d'un compte, et lister le catalogue de sujets auquel font référence les préférences de notification.

## Endpoints

| Endpoint | Requête |
| - | - |
| [Lister les notifications](https://docs.whop.com/fr/api-reference/notifications/list-notifications.md) | GET `/notifications` |
| [Récupérer une notification](https://docs.whop.com/fr/api-reference/notifications/retrieve-notification.md) | GET `/notifications/{id}` |
| [Lister les badges de notification](https://docs.whop.com/fr/api-reference/notifications/list-notification-badges.md) | GET `/notifications/badges` |
| [Lister les sujets de notification](https://docs.whop.com/fr/api-reference/notifications/list-notification-topics.md) | GET `/notifications/topics` |
| [Envoyer une notification](https://docs.whop.com/fr/api-reference/notifications/send-notification.md) | POST `/notifications` |
| [Marquer les notifications comme lues](https://docs.whop.com/fr/api-reference/notifications/mark-notifications-read.md) | POST `/notifications/mark_read` |

## Attributs

**id** `string` *required*

ID de la notification. Les lignes du fil portent un id composite qui sert également
de curseur de liste.

**account** `object | null` *required*

Compte auquel appartient la notification. `null` lorsque la notification n'est associée à aucun compte.

> [accordion] Propriétés
>
> **id** `string` *required*
>
> ID du compte, préfixé par `biz_`.
>
> **logo\_url** `string | null` *required*
>
> URL de l'image du logo du compte. `null` lorsque le compte n'en a pas téléversé.
>
> **route** `string | null` *required*
>
> Slug d'URL de la page boutique du compte sur whop.com.
>
> **title** `string` *required*
>
> Nom d'affichage du compte.

**attachment\_url** `string` *required*

Image affichée à côté de la notification — l'avatar de l'expéditeur, ou
l'image de notification par défaut.

**content** `string` *required*

Le corps du texte de la notification affiché à l'utilisateur.

**created\_at** `string` *required*

Date de création de la notification, sous forme d'horodatage ISO 8601.

**experience** `object | null` *required*

Expérience à laquelle la notification est liée. `null` lorsqu'elle n'est liée à aucune expérience spécifique.

> [accordion] Propriétés
>
> **id** `string` *required*
>
> ID de l'expérience, préfixé par `exp_`.
>
> **app** `object | null` *required*
>
> App à laquelle appartient l'expérience.
>
> > [accordion] Propriétés
> >
> > **id** `string` *required*
> >
> > ID de l'app, préfixé par `app_`.
> >
> > **icon\_url** `string` *required*
> >
> > URL de l'image de l'icône. Toujours présente — l'icône d'app par défaut lorsqu'aucune n'a été téléversée.
>
> **name** `string | null` *required*
>
> Nom d'affichage de l'expérience.

**iframe\_link** `string | null` *required*

La même destination sur le propre domaine de l'app, que les clients web et mobile
de Whop intègrent au lieu d'y naviguer. Pertinent uniquement si vous affichez vous-même
des apps Whop. `null` lorsque la notification porte son propre `link`.

**link** `string | null` *required*

La page whop.com que la notification ouvre, sous forme de navigation de premier niveau classique.
C'est le lien à utiliser, sauf si vous hébergez vous-même des apps Whop. `null` lorsque la
notification n'a pas de destination au clic.

**mentions\_me** `boolean` *required*

Indique si l'utilisateur authentifié a été directement mentionné dans cette notification.

**rest\_path** `string | null` *required*

Informations de chemin supplémentaires ajoutées au lien profond de la notification, le cas échéant.

**sender** `object | null` *required*

Utilisateur qui a déclenché la notification. `null` lorsqu'elle a été générée par le système.

> [accordion] Propriétés
>
> **id** `string` *required*
>
> ID de l'utilisateur, préfixé par `user_`.
>
> **name** `string | null` *required*
>
> Nom d'affichage.
>
> **username** `string` *required*
>
> Nom d'utilisateur public.

**subject** `string` *required*

La ligne de titre de la notification affichée à l'utilisateur.

**topic** `object | null` *required*

Catégorie de sujet à laquelle appartient la notification, utilisée pour le regroupement et la gestion des préférences. `null` lorsqu'elle n'est pas catégorisée.

> [accordion] Propriétés
>
> **id** `string` *required*
>
> ID du sujet de notification, préfixé par `topic_`.
>
> **default\_preference\_value** `boolean` *required*
>
> Indique si les notifications de ce sujet sont activées par défaut lorsque l'utilisateur n'a
> pas défini de préférence.
>
> **is\_mention** `boolean` *required*
>
> Indique si ce sujet gère exclusivement les notifications basées sur des mentions.
>
> **topic\_type** `string` *required*
>
> Portée du sujet : indique s'il s'applique à un compte, à un utilisateur ou à l'équipe d'un compte.
>
> Options disponibles : `account`, `user`, `account_team`

```json Notification theme={null}
{
	"id": "ntfr_xxxxxxxxxxxxxx:xxxxxxxxxxxxx",
	"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"
	},
	"content": "Tuesday 9:00 AM, Bay 2",
	"created_at": "2026-09-15T14:30:00.000Z",
	"experience": {
		"id": "exp_xxxxxxxxxxxxxx",
		"app": {
			"id": "app_xxxxxxxxxxxxxx",
			"icon_url": "https://pub-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.r2.dev/custom-perk-icon.svg"
		},
		"name": "Bookings"
	},
	"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/",
	"mentions_me": false,
	"rest_path": "/bookings/upcoming",
	"sender": {
		"id": "user_xxxxxxxxxxxxxx",
		"name": "Tanya Cole",
		"username": "tanyacole"
	},
	"subject": "Your ceramic coating is booked",
	"topic": {
		"id": "topic_xxxxxxxxxxxxxx",
		"default_preference_value": true,
		"is_mention": false,
		"topic_type": "user"
	},
	"attachment_url": "https://ui-avatars.com/api/?name=Tanya+Cole"
}
```


## Related topics

- [Create notification](https://docs.whop.com/fr/api-reference/legacy/notifications/create-notification.md)
- [List Notifications](https://docs.whop.com/fr/api-reference/notifications/list-notifications.md)
- [Send Notification](https://docs.whop.com/fr/api-reference/notifications/send-notification.md)
