Sign in
latestOpenAPI 3.1.02026-08-1014497184.0 KB

8b99dca11019

Fetch a notification

Gets a notification by ID.

get/notifications/{notification_id}

Path parameters

notification_idstring required

Response

OK

action_urlstring nullable

The link associated with the notification.

archived_atstring date-time nullable

The timestamp when the notification was archived.

categorystring nullable

The category grouping for the notification.

contentstring nullable

The body content of the notification.

created_atstring date-time required

The timestamp when the notification was created.

custom_attributesobject nullable

The custom data stored with the notification.

discarded_atstring date-time nullable

The timestamp when the notification was discarded.

idstring uuid required

The unique identifier for the notification.

read_atstring date-time nullable

The timestamp when the notification was marked as read.

seen_atstring date-time nullable

The timestamp when the notification was seen.

sent_atstring date-time nullable

The timestamp when the notification was sent.

status'unseen' | 'unread' | 'read' | 'archived' required

The current status of the notification.

titlestring required

The title that is displayed to recipients.

topicstring nullable

The topic for additional classification.

updated_atstring date-time required

The timestamp when the notification was last updated.

user_idstring uuid required

The user that should receive the notification.

Example response

{
  "action_url": null,
  "archived_at": null,
  "category_id": null,
  "created_at": "2024-09-11T11:14:42.165Z",
  "custom_attributes": {
    "key": "value",
    "obj_key": {
      "one": "two"
    }
  },
  "discarded_at": null,
  "id": "4b6efd21-f0f6-4051-8922-cc8c90a3dc5d",
  "in_app": true,
  "metadata": {},
  "notification_broadcast_id": "6a8b1e23-f54b-4c65-95b2-78f288d7f247",
  "overrides": {},
  "project_id": 7,
  "read_at": null,
  "seen_at": null,
  "status": "unseen",
  "title": "Example Notification",
  "topic_id": null,
  "updated_at": "2024-09-11T11:14:42.165Z",
  "user_id": "d4121424-097e-40b0-9cc8-357060d004b2"
}