Sign in
Notification

Retrieve a notification

Returns a single notification of the current company (resolved from the company-id header).

get/v1/notifications/{id}

Path parameters

idstring required

The id of the resource. This is a UUID for most resources, but for user endpoints it is the user's Firebase UID (an opaque string), so no uuid format is asserted here.

Parameters

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

Response

The requested notification.

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