Sign in
Notification

List notifications

Returns the authenticated user's visible in-app notifications for the current company (resolved from the company-id header), most recent first.

get/v1/notifications

Parameters

#/paths/~1v1~1users/get/parameters/0 — unresolved $ref
#/paths/~1v1~1users/get/parameters/1 — unresolved $ref
#/paths/~1v1~1users/get/parameters/2 — unresolved $ref
#/paths/~1v1~1users/get/parameters/3 — unresolved $ref
#/paths/~1v1~1users/get/parameters/4 — unresolved $ref

Response

Paginated list of notifications.

idstring uuid required
typestring nullable

Notification subclass, e.g. TransactionApprovedNotifier::Notification.

event_idstring uuid
recipient_typestring
recipient_idstring

Firebase UID of the recipient user.

read_atstring date-time nullable

Timestamp the notification was read; null when unread.

seen_atstring date-time nullable
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "recipient_type": "User"
  }
]

Changes