Skip to main content
GET
Get push notification

Authorizations

Authorization
string
header
required

Opaque Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

externalId
string
required

The external identifier of the push notification to retrieve.

Response

Success

id
integer<int64>

Internal unique identifier of the push notification.

title
string | null

Title of the push notification.

name
string | null

Name of the push activity. Falls back to the title for activities created without a name.

state
string | null

Current state of the push notification (e.g., Draft, Scheduled, Delivered).

status
enum<integer>
Available options:
1,
2,
3,
4,
5
deliveryDate
string<date-time> | null

The scheduled delivery date of the push notification.

modifiedDate
string<date-time>

The date and time when the push notification was last modified.

authorId
string | null

Identifier of the author who created the push notification.

authorName
string | null

Name of the author who created the push notification.

message
string | null

Message content of the push notification.

expirationDate
string<date-time> | null

Expiration date after which the notifications will no longer be sent.

isReadyToDistribute
boolean

Indicates whether the notification is ready to be distributed.

isSegmented
boolean | null
deprecated

Obsolete. Indicates if the notification is segmented. Use Push.Api.DTO.GetNotificationResponse.SegmentationType instead.

segmentationType
enum<integer>
Available options:
0,
1,
2,
3
createdDate
string<date-time>

The date and time when the push notification was created.

segmentation
object
audienceIds
string[] | null

List of audience IDs targeted by the notification.

sentCount
integer<int64> | null

Count of subscribed devices to which the notifications are sent.

openedCount
integer<int64> | null

Number of recipients who opened the notification.

deliveredCount
integer<int64> | null

Count of delivered messages which were received by the user.

storeId
string | null

Identifier for store targeted by the notification

unifiedCampaignId
string | null

Unified campaign identifier

externalId
string | null

External identifier of the notification.

externalUrl
string | null

External URL linked to the content or notification.

segmentationFile
file | null
deprecated
read-only

Obsolete. Use file info from Push.Api.DTO.SegmentationInfo instead.

Last modified on August 10, 2026