> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unblockedbrands.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get wallet pass notification by ID

> Retrieve a specific wallet pass notification by its unique identifier.
Optionally include notification statistics and click tracking data.




## OpenAPI

````yaml api-reference/openapi.json get /wallet-pass/notifications/{id}
openapi: 3.1.0
info:
  title: Unblocked Wallet Passes API
  description: Unblocked Wallet Passes API
  version: 1.0.0
servers:
  - url: https://api.ubpass.co/v1
    description: Generated server url
security:
  - AccessToken: []
  - APIKey: []
tags:
  - name: Pique
    description: Get Pique Campaigns and their video performance data
  - name: Passport - Passes
    description: >-
      Create, update, retrieve, and delete wallet passes for Apple and Google
      platforms
  - name: Passport - Push Notifications
    description: Create, update, get, and delete wallet pass notifications
  - name: Passport - Locations
    description: Create, update, get, and delete wallet pass locations
  - name: Upload APIs
    description: Upload and manage pass assets and images
paths:
  /wallet-pass/notifications/{id}:
    get:
      tags:
        - Passport - Push Notifications
      summary: Get wallet pass notification by ID
      description: |
        Retrieve a specific wallet pass notification by its unique identifier.
        Optionally include notification statistics and click tracking data.
      operationId: getPassNotification
      parameters:
        - name: x-workspace-id
          in: header
          description: >-
            Workspace ID to perform the operation in. If not provided, system
            will use the first one assigned to the user
          required: false
          schema:
            type: string
            pattern: ^[a-zA-Z0-9-_]+$
          example: 1f089d29-6f9c-66c2-af59-99631cec7ab5
        - name: id
          in: path
          description: Unique identifier of the notification to retrieve
          required: true
          schema:
            type: string
            pattern: ^[a-zA-Z0-9-_]+$
          example: 1f089d37-5ebe-6778-af59-99631cec7ab5
        - name: notificationStatsCursor
          in: query
          description: >-
            Pagination cursor for fetching the next set of notification
            statistics records. Use the 'cursor' value from the previous
            response.
          required: false
          schema:
            type: integer
            minimum: 0
          example: 0
        - name: notificationStatsLimit
          in: query
          description: >-
            Number of notification statistics records to return per page (1-20,
            max 20)
          required: false
          schema:
            type: integer
            maximum: 20
            minimum: 1
          example: 20
        - name: includeStats
          in: query
          description: Include notification statistics and click tracking data
          required: false
          schema:
            type: boolean
          example: false
      responses:
        '200':
          description: Successfully retrieved wallet pass notification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PassNotification'
              examples:
                Success Response:
                  summary: Wallet pass notification details
                  description: Success Response
                  value:
                    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'
        '401':
          description: Unauthorized - Invalid or missing authentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnblockedApiError'
              examples:
                Unauthorized Error:
                  summary: Authentication failed
                  description: Unauthorized Error
                  value:
                    txId: Root=1-68d3693c-26a3db2278c7668f5e086711
                    timestamp: 24-09-2025 03:45:00
                    errorCode: UNAUTHORIZED
                    errorMessage: UNAUTHORIZED.
        '404':
          description: Not Found - Notification ID not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnblockedApiError'
              examples:
                Not Found Error:
                  summary: Notification not found
                  description: Not Found Error
                  value:
                    txId: 1f098fa9-3786-64d4-b4ff-533200846d35
                    timestamp: 24-09-2025 03:57:23
                    errorCode: NOT_FOUND
                    errorMessage: Not found.
                    context:
                      id: 1f083424-11ed-617f-9513-1b26dc975ee2
components:
  schemas:
    PassNotification:
      type: object
      properties:
        id:
          type: string
        createdTime:
          type: string
          format: date-time
          description: >-
            The time when the entity was created in ISO 8601 format including
            milliseconds and timezone offset.
          example: '2025-05-13T15:07:15.036Z'
        updatedTime:
          type: string
          format: date-time
          description: >-
            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:
          type: string
          description: The user who created the entity.
        updatedBy:
          type: string
          description: The user who last updated the entity.
        workspaceId:
          type: string
          description: workspace id to which the notification belongs.
        passSerialNumber:
          type: string
          description: Wallet pass id to which the notification belongs.
        notificationName:
          type: string
          description: >-
            Notification name. This is will not appear on pass, it's used
            internally to identify the notification.
        notificationMessage:
          type: string
          description: >-
            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:
          type: string
          description: >-
            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.
          enum:
            - Draft
            - Initializing
            - Processing
            - Finalizing
            - Published
            - Scheduled
            - AppleFailedGoogleSuccess
            - AppleSuccessGoogleFailed
            - Failed
        publishedTime:
          type: string
          format: date-time
          description: >-
            Time when the notification was sent in ISO 8601 format including
            milliseconds and timezone offset.
        scheduledTime:
          type: string
          format: date-time
          description: >-
            Time when the notification will be sent in ISO 8601 format including
            milliseconds and timezone offset.
        appleNotificationSentCount:
          type: integer
          format: int32
          description: >-
            Number of active users who have received this notification on their
            Apple Wallets.
        googleNotificationSentCount:
          type: integer
          format: int32
          description: >-
            Number of active users who have received this notification on their
            Google Wallets.
        totalNotificationSentCount:
          type: integer
          format: int32
          description: >-
            Total number of active users who have received this notification on
            their wallets (Apple + Google).
        notificationStats:
          $ref: '#/components/schemas/NotificationStats'
          description: >-
            stats for the notification, it contains the total number of
            notifications sent and link stats.
      required:
        - notificationName
        - passSerialNumber
    UnblockedApiError:
      type: object
      properties:
        txId:
          type: string
        timestamp:
          type: string
          format: date-time
        errorCode:
          type: string
        errorMessage:
          type: string
        context:
          type: object
          additionalProperties: {}
    NotificationStats:
      type: object
      properties:
        id:
          type: string
        createdTime:
          type: string
          format: date-time
          description: >-
            The time when the entity was created in ISO 8601 format including
            milliseconds and timezone offset.
          example: '2025-05-13T15:07:15.036Z'
        updatedTime:
          type: string
          format: date-time
          description: >-
            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:
          type: string
          description: The user who created the entity.
        updatedBy:
          type: string
          description: The user who last updated the entity.
        workspaceId:
          type: string
          description: The ID of the workspace to which this entity belongs.
        totalNotificationsSent:
          type: integer
          format: int32
        totalLinksClicks:
          type: integer
          format: int32
        linkStats:
          $ref: '#/components/schemas/BXPagedListWorkspaceTopLinkStats'
    BXPagedListWorkspaceTopLinkStats:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceTopLinkStats'
        cursor:
          type: string
        hasMore:
          type: boolean
    WorkspaceTopLinkStats:
      type: object
      properties:
        id:
          type: string
        createdTime:
          type: string
          format: date-time
          description: >-
            The time when the entity was created in ISO 8601 format including
            milliseconds and timezone offset.
          example: '2025-05-13T15:07:15.036Z'
        updatedTime:
          type: string
          format: date-time
          description: >-
            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:
          type: string
          description: The user who created the entity.
        updatedBy:
          type: string
          description: The user who last updated the entity.
        workspaceId:
          type: string
          description: The ID of the workspace to which this entity belongs.
        linkUrl:
          type: string
        totalClicks:
          type: integer
          format: int32
  securitySchemes:
    AccessToken:
      type: http
      description: Bearer token authentication
      scheme: bearer
      bearerFormat: JWT
    APIKey:
      type: apiKey
      description: API Key authentication
      name: api-key
      in: header

````