Skip to main content
GET
Get a notification

Path Parameters

id
string
required

The notification ID.

Response

OK

API DTO containing notification data used by Leadping API contracts.

type
enum<string>

The type classification for this notification.

Available options:
General,
Lead,
Call,
Sms,
Billing,
System,
Success,
Warning,
Error,
Info,
Announcement,
Activation
priority
enum<string>

The priority value for this notification.

Available options:
Low,
Medium,
High,
Critical
userId
string

The user ID associated with this notification.

message
string

The message value for this notification.

details
string | null

The details value for this notification.

readAt
string<date-time> | null

The date and time for the read at value on this notification.

isRead
boolean

Whether this notification is read.

actionUrl
string | null

The URL associated with this notification.

actionButtonText
string | null

The action button text value for this notification.

The related entity ID associated with this notification.

The related entity type classification for this notification.

name
string

The display name for the entity.

id
string

The unique identifier for the entity.

createdAt
string<date-time>

The date and time when the entity was created.

modifiedAt
string<date-time> | null

The date and time when the entity was last modified, if applicable.