Skip to main content
GET
/
wallet-pass
/
notifications
Search and filter wallet pass notifications
curl --request GET \
  --url https://api.ubpass.co/v1/wallet-pass/notifications \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "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"
    },
    {
      "id": "1f089d37-8a1b-4c2d-9e3f-123456789abc",
      "createdTime": "2025-09-04T20:30:15.456Z",
      "updatedTime": "2025-09-04T20:30:15.456Z",
      "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": "Special Offer Alert",
      "notificationMessage": "Limited time offer! Get 20% off your next purchase with your VIP membership.",
      "status": "Scheduled",
      "scheduledTime": "2025-09-05T14:00:00.000Z",
      "sentTime": null
    }
  ],
  "cursor": "1f089d37-8a1b-4c2d-9e3f-123456789abc",
  "hasMore": true
}

Authorizations

Authorization
string
header
required

Bearer token 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

Pattern: ^[a-zA-Z0-9-_]+$

Query Parameters

query
string

Search keyword to filter notifications by name (case-insensitive)

Maximum string length: 255
cursor
string

Pagination cursor for fetching the next set of results. Use the 'cursor' value from the previous response.

limit
integer

Number of notifications to return per page (1-20, max 20)

Required range: 1 <= x <= 20
passSerialNumber
string[]

Filter by specific wallet pass serial numbers

Pattern: ^[a-zA-Z0-9-_]+$
status
enum<string>[]

Filter notifications by status. Multiple values allowed.

Available options:
Draft,
Scheduled,
Processing,
Published,
Failed
ids
string[]

Filter by notification ID list

Response

Successfully retrieved wallet pass notifications

items
any[]
cursor
string
hasMore
boolean