Notification

Get an in-app notification

Return the requested notification by its ID.

get/v1/notifications/{id}

Request

Base URL: https://example.com/api
URL: https://example.com/api/v1/notifications/{id}
Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: notification.read)

idstring required

Unique identifier of the in-app notification.

titlestring required

Title of the in-app notification.

descriptionstring required

Description of the in-app notification.

recipientstring required

ID of the user who got notified.

readboolean required

Whether the notification was read by the user.

created_atstring date-time required

Date when the todo item was created.

updated_atstring date-time nullable required

Date when the in-app notification was updated.

{
  "id": "9bsv0s46s6s002p9ltq0",
  "title": "Do something great",
  "description": "Make the world a better place!"
}