Skip to main content
GET
/
api
/
v1
/
ops
/
notifications
/
{notificationRecipientId}
Get Notification
curl --request GET \
  --url https://api.example.com/api/v1/ops/notifications/{notificationRecipientId} \
  --header 'Authorization: Bearer <token>'
{
  "notificationRecipientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "notificationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recipientUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deliveredAt": "2023-11-07T05:31:56Z",
  "readAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
notificationRecipientId
string<uuid>
required

Notification recipient identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Estado individual de uma notificação para um usuário destinatário

​
notificationRecipientId
string<uuid>
required

Identificador único

​
notificationId
string<uuid>
required

Notificação recebida

​
recipientUserId
string<uuid>
required

Usuário destinatário

​
deliveredAt
string<date-time> | null
required

Data em que foi entregue via realtime ou inbox

​
readAt
string<date-time> | null
required

Data em que foi marcada como lida

​
archivedAt
string<date-time> | null
required

Data em que foi arquivada

​
status
enum<string>
required

Estado da notificação para o destinatário

Available options:
UNREAD,
READ,
ARCHIVED
​
createdBy
string<uuid> | null
required

Usuário que criou o registro, quando aplicável

​
createdAt
string<date-time>
required

Data de criação

​
updatedBy
string<uuid> | null
required

Usuário que fez a última atualização, quando aplicável

​
updatedAt
string<date-time>
required

Data da última atualização

​
deletedBy
string<uuid> | null
required

Usuário que removeu o registro, quando aplicável

​
deletedAt
string<date-time> | null
required

Data de remoção lógica