GET
/
wallet-pass
/
notifications
/
{id}
Get Pass notification by ID
curl --request GET \
  --url https://api.ubpass.co/v1/wallet-pass/notifications/{id} \
  --header 'api-key: <api-key>'
{
  "id": "1f089d37-5ebe-6778-af59-99631cec7ab5",
  "createdTime": "2025-09-04T21:09:36.027Z",
  "updatedTime": "2025-09-04T21:11:01.734Z",
  "createdBy": "1ef58ae6-40ac-6fd2-96af-45801844c4e2",
  "updatedBy": "1ef58ae6-40ac-6fd2-96af-45801844c4e2",
  "workspaceId": "1f089d29-6f9c-66c2-af59-99631cec7ab5",
  "accountId": "1f089d29-6fa8-6a13-af59-99631cec7ab5",
  "passSerialNumber": "1f09804f-d6c7-66ec-8db2-27a5651e1de2",
  "notificationName": "VIP Member Update",
  "notificationMessage": "Your VIP membership benefits have been updated! Check out the new exclusive offers.",
  "status": "Published",
  "scheduledTime": "2025-09-04T10:00:00.000Z",
  "sentTime": "2025-09-04T10:00:15.123Z"
}

Authorizations

​
api-key
string
header
required

API Key authentication

Headers

​
x-workspace-id
string

Workspace ID to perform the operation in. If not provided, system will use the first one assigned to the user

Path Parameters

​
id
string
required

Unique identifier of the notification to retrieve

Query Parameters

​
notificationStatsCursor
integer

Pagination cursor for fetching the next set of notification statistics records. Use the 'cursor' value from the previous response.

Required range: x >= 0
​
notificationStatsLimit
integer

Number of notification statistics records to return per page (1-20, max 20)

Required range: 1 <= x <= 20
​
includeStats
boolean

Include notification statistics and click tracking data

Response

Successfully retrieved wallet pass notification

​
passSerialNumber
string
required

Wallet pass id to which the notification belongs.

​
notificationName
string
required

Notification name. This is will not appear on pass, it's used internally to identify the notification.

​
id
string
​
createdTime
string<date-time>

The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.

Example:

"2025-05-13T15:07:15.036Z"

​
updatedTime
string<date-time>

The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset.

Example:

"2025-05-13T15:07:15.036Z"

​
createdBy
string

The user who created the entity.

​
updatedBy
string

The user who last updated the entity.

​
workspaceId
string

workspace id to which the notification belongs.

​
notificationMessage
string

Notification message. For Apple passes, this message will be displayed on the lock screen when a notification is sent to the pass. For Google passes, this message will be displayed at the back of the pass when a notification is sent to the pass.

​
status
enum<string>

Notification status: Draft: Notification will not be sent until the status is changed to Scheduled or ProcessingScheduled: Notification is scheduled to be sent at a specific time. Processing: Notification is being sent. Published: Notification has been sent.Failed: Notification failed to be sent. If the status is not specified at the time of creation, it will be sent immediately.

Available options:
Draft,
Initializing,
Processing,
Finalizing,
Published,
Scheduled,
AppleFailedGoogleSuccess,
AppleSuccessGoogleFailed,
Failed
​
publishedTime
string<date-time>

Time when the notification was sent in ISO 8601 format including milliseconds and timezone offset.

​
scheduledTime
string<date-time>

Time when the notification will be sent in ISO 8601 format including milliseconds and timezone offset.

​
appleNotificationSentCount
integer

Number of active users who have received this notification on their Apple Wallets.

​
googleNotificationSentCount
integer

Number of active users who have received this notification on their Google Wallets.

​
totalNotificationSentCount
integer

Total number of active users who have received this notification on their wallets (Apple + Google).

​
notificationStats
object