> ## 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.

# Notifications API

> Een Notification is een bericht dat aan een gebruiker wordt bezorgd, zoals een nieuwe post, een betaling of een vermelding.

Elke notificatie komt van een experience waartoe de gebruiker behoort of van een team waarin de gebruiker zit, en valt onder een topic, zoals nieuwe verkopen, waarvoor gebruikers voorkeuren instellen.

Gebruik de Notifications API om de feed van een gebruiker op te vragen, ongelezen badges te lezen en te wissen, notificaties vanuit je app naar de gebruikers van een experience of het team van een account te sturen, en de topiccatalogus op te vragen waarnaar notificatievoorkeuren verwijzen.

## Endpoints

| Endpoint | Verzoek |
| - | - |
| [Notificaties opvragen](https://docs.whop.com/nl/api-reference/notifications/list-notifications.md) | GET `/notifications` |
| [Notificatie ophalen](https://docs.whop.com/nl/api-reference/notifications/retrieve-notification.md) | GET `/notifications/{id}` |
| [Notificatiebadges opvragen](https://docs.whop.com/nl/api-reference/notifications/list-notification-badges.md) | GET `/notifications/badges` |
| [Notificatietopics opvragen](https://docs.whop.com/nl/api-reference/notifications/list-notification-topics.md) | GET `/notifications/topics` |
| [Notificatie versturen](https://docs.whop.com/nl/api-reference/notifications/send-notification.md) | POST `/notifications` |
| [Notificaties als gelezen markeren](https://docs.whop.com/nl/api-reference/notifications/mark-notifications-read.md) | POST `/notifications/mark_read` |

## Attributen

**id** `string` *required*

Notification-ID. Feedrijen hebben een samengestelde id die ook dienstdoet als cursor voor de lijst.

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

Account waartoe de notificatie behoort. `null` wanneer de notificatie niet aan een account is gekoppeld.

> [accordion] Eigenschappen
>
> **id** `string` *required*
>
> Account-ID, met prefix `biz_`.
>
> **logo\_url** `string | null` *required*
>
> URL van de logo-afbeelding van het account. `null` wanneer het account er geen heeft geüpload.
>
> **route** `string | null` *required*
>
> URL-slug van de winkelpagina van het account op whop.com.
>
> **title** `string` *required*
>
> Weergavenaam van het account.

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

Afbeelding die naast de notificatie wordt getoond — de avatar van de afzender, of de standaard notificatieafbeelding.

**content** `string` *required*

De hoofdtekst van de notificatie die aan de gebruiker wordt getoond.

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

Wanneer de notificatie is aangemaakt, als ISO 8601-tijdstempel.

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

Experience waarop de notificatie betrekking heeft. `null` wanneer deze niet aan een specifieke experience is gekoppeld.

> [accordion] Eigenschappen
>
> **id** `string` *required*
>
> Experience-ID, met prefix `exp_`.
>
> **app** `object | null` *required*
>
> App waartoe de experience behoort.
>
> > [accordion] Eigenschappen
> >
> > **id** `string` *required*
> >
> > App-ID, met prefix `app_`.
> >
> > **icon\_url** `string` *required*
> >
> > URL van de pictogramafbeelding. Altijd aanwezig — het standaard app-pictogram wanneer er geen is geüpload.
>
> **name** `string | null` *required*
>
> Weergavenaam van de experience.

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

Dezelfde bestemming op het eigen domein van de app, die de web- en mobiele clients van Whop insluiten in plaats van ernaartoe te navigeren. Alleen relevant als je Whop-apps zelf rendert. `null` wanneer de notificatie een eigen `link` heeft.

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

De whop.com-pagina die de notificatie opent, als normale top-level navigatie. Dit is de link die je gebruikt, tenzij je Whop-apps zelf host. `null` wanneer de notificatie geen doorklikbestemming heeft.

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

Of de geauthenticeerde gebruiker rechtstreeks in deze notificatie is vermeld.

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

Aanvullende padinformatie die aan de deep link van de notificatie wordt toegevoegd, indien aanwezig.

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

Gebruiker die de notificatie heeft geactiveerd. `null` wanneer deze door het systeem is gegenereerd.

> [accordion] Eigenschappen
>
> **id** `string` *required*
>
> User-ID, met prefix `user_`.
>
> **name** `string | null` *required*
>
> Weergavenaam.
>
> **username** `string` *required*
>
> Openbare gebruikersnaam.

**subject** `string` *required*

De titelregel van de notificatie die aan de gebruiker wordt getoond.

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

Topiccategorie waartoe de notificatie behoort, gebruikt voor groepering en voorkeurenbeheer. `null` wanneer niet gecategoriseerd.

> [accordion] Eigenschappen
>
> **id** `string` *required*
>
> Notification topic-ID, met prefix `topic_`.
>
> **default\_preference\_value** `boolean` *required*
>
> Of notificaties voor dit topic standaard zijn ingeschakeld wanneer de gebruiker geen voorkeur heeft ingesteld.
>
> **is\_mention** `boolean` *required*
>
> Of dit topic uitsluitend notificaties op basis van vermeldingen afhandelt.
>
> **topic\_type** `string` *required*
>
> Bereik van het topic: of het van toepassing is op een account, een gebruiker of het team van een account.
>
> Beschikbare opties: `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/nl/api-reference/legacy/notifications/create-notification.md)
- [List Notifications](https://docs.whop.com/nl/api-reference/notifications/list-notifications.md)
- [Retrieve Notification](https://docs.whop.com/nl/api-reference/notifications/retrieve-notification.md)
