Référence APILister le fil de notifications
GET/v1/notifications/feed

Lister le fil de notifications

Récupère les notifications in-app non archivées de l'utilisateur courant, les plus récentes d'abord.

1 min de lectureTélécharger en PDF

Réponse exemple

{
"data": [
{
"id": "ntf_9f2a1c7e",
"body": "Marie Dupont vous a envoyé 3 documents.",
"href": "/dashboard/transfers/9f2a1c7e",
"title": "Transfert reçu",
"blocks": [
{
"text": "3 documents en attente de validation.",
"type": "text"
}
],
"read_at": null,
"cta_label": "Voir le transfert",
"created_at": "2026-06-05T09:42:11.000Z"
},
{
"id": "ntf_4b8d0a31",
"title": "Signature finalisée",
"read_at": "2026-06-04T18:20:43.000Z",
"created_at": "2026-06-04T17:05:00.000Z"
}
]
}

Renvoie la liste des notifications in-app de l'utilisateur authentifié, telles qu'affichées dans la cloche du tableau de bord. Seules les notifications non archivées sont retournées (archived_at est null), triées par date de création décroissante (les plus récentes d'abord). Cette route est distincte de /v1/notifications, qui gère les préférences de notification : elle est dédiée au flux d'événements affichables.

GET/v1/notifications/feedListe les notifications in-app non archivées de l'utilisateur courant.

Authentification

Requiert une clé API valide (ou une session utilisateur), aucun scope spécifique. La route s'appuie sur requireUser, qui résout l'utilisateur courant : les notifications renvoyées sont strictement celles dont le user_id correspond à cet utilisateur. Aucune notification d'un autre utilisateur ne peut être lue via cet endpoint.

Paramètres de requête

ParamètreTypeRequisDescription
limitentierNonNombre maximal de notifications à renvoyer. Valeur par défaut 5. Bornée automatiquement entre 1 et 50 (toute valeur hors plage est ramenée dans ces limites ; une valeur non numérique retombe sur 5).

Réponse

Réponse 200 contenant un objet avec une clé data : un tableau de notifications. Chaque entrée expose id, title, created_at et read_at (timestamp de lecture, ou null si non lue). Les champs body, href (lien d'action, issu de la colonne url), cta_label (libellé du bouton) et blocks (contenu structuré, tableau) sont optionnels et omis lorsqu'ils sont absents. Un tableau vide est renvoyé si l'utilisateur n'a aucune notification active.

ChampTypeDescription
data[].idstringIdentifiant unique de la notification.
data[].titlestringTitre de la notification.
data[].bodystringCorps du message (optionnel, omis si absent).
data[].created_atstring (ISO 8601)Date de création de la notification.
data[].read_atstring | nullDate de lecture, ou null si la notification n'a pas été lue.
data[].hrefstringLien d'action associé (optionnel, omis si absent).
data[].cta_labelstringLibellé du bouton d'appel à l'action (optionnel, omis si absent).
data[].blocksarrayContenu structuré en blocs (optionnel, présent uniquement s'il s'agit d'un tableau).

Erreurs

CodeQuandRésolution
401 unauthorizedAucune session ou clé API valide n'identifie un utilisateur.Authentifiez la requête avec une clé API valide ou une session active, puis réessayez.

Voir aussi

  • GET /v1/notifications — gère les préférences de notification de l'utilisateur (ne pas confondre avec ce fil).
  • GET /v1/transfers — détaille les transferts souvent référencés par les notifications via href.