Notifications

Get a current-user notification

Returns one notification for the current user and organization, including its content, read state, delivery context, and relevant account activity.

get/notifications/{id}

Request

  • Base URL: https://api.leadping.ai
  • URL: https://api.leadping.ai/notifications/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The notification ID.

Response

OK

organizationIdstring nullable

The organization selected before opening this notification.

conversationIdstring nullable

The mobile conversation destination.

leadIdstring nullable

The lead used to resolve the conversation.

isDemoboolean
type'General' | 'Lead' | 'Call' | 'Sms' | 'Billing' | 'System' | 'Success' | 'Warning' | 'Error' | 'Info' | 'Announcement' | 'Activation'

Identifies the Leadping workflow or account event communicated by a user notification.

priority'Low' | 'Medium' | 'High' | 'Critical'

Ranks the urgency and presentation importance of a Leadping user notification.

userIdstring

The user ID associated with this notification.

messagestring

Message for this notification.

detailsstring nullable

Optional supporting details displayed beneath the notification message.

readAtstring date-time nullable

UTC timestamp for read at on this notification.

isReadboolean

Whether this notification is read.

pushEnabledboolean

Whether this notification should also be delivered as a device push notification.

actionUrlstring nullable

The URL associated with this notification.

actionButtonTextstring nullable

Action button text for this notification.

relatedEntityIdstring nullable

The related entity ID associated with this notification.

relatedEntityTypestring nullable

The related entity type classification for this notification.

namestring
idstring
createdAtstring date-time
modifiedAtstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.