> ## 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.

# Search and filter Wallet Passes

> Search and retrieve Wallet Passes with optional filtering and pagination.

**Features:**
- Search passes by name using keyword query (case-insensitive)
- Filter by pass status (Draft, Published)
- Filter by specific pass ID or pass name
- Pagination support with cursor-based navigation
- Option to include pass assets (images) in response
- Option to return summary-only information

**Pagination:**
- Use `cursor` parameter for next page navigation
- `limit` controls page size (default: 20, max: 20)
- Response includes `items` array, `cursor`, and `hasMore` fields




## OpenAPI

````yaml api-reference/openapi.json get /wallet-pass
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:
    get:
      tags:
        - Passport - Passes
      summary: Search and filter Wallet Passes
      description: >
        Search and retrieve Wallet Passes with optional filtering and
        pagination.


        **Features:**

        - Search passes by name using keyword query (case-insensitive)

        - Filter by pass status (Draft, Published)

        - Filter by specific pass ID or pass name

        - Pagination support with cursor-based navigation

        - Option to include pass assets (images) in response

        - Option to return summary-only information


        **Pagination:**

        - Use `cursor` parameter for next page navigation

        - `limit` controls page size (default: 20, max: 20)

        - Response includes `items` array, `cursor`, and `hasMore` fields
      operationId: getPassList
      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: query
          in: query
          description: Search keyword to filter passes by name (case-insensitive)
          required: false
          schema:
            type: string
            maxLength: 255
          example: VIP MEMBERSHIP PASS
        - name: cursor
          in: query
          description: >-
            Pagination cursor for fetching the next set of results. Use the
            'cursor' value from the previous response.
          required: false
          schema:
            type: string
          example: 1f089d37-5ebe-6778-af59-99631cec7ab5
        - name: limit
          in: query
          description: Number of passes to return per page (1-20, max 20)
          required: false
          schema:
            type: integer
            maximum: 20
            minimum: 1
          example: 20
        - name: includePassAssets
          in: query
          description: Include pass asset URLs (images) in the response
          required: false
          schema:
            type: boolean
          example: true
        - name: summary
          in: query
          description: Return only basic pass information (summary mode)
          required: false
          schema:
            type: boolean
          example: false
        - name: id
          in: query
          description: Filter by specific pass ID
          required: false
          schema:
            type: string
            pattern: ^[a-zA-Z0-9-_]+$
          example: 1f089d37-5ebe-6778-af59-99631cec7ab5
        - name: ids
          in: query
          description: Filter by a list of pass IDs
          required: false
          schema:
            type: array
            items:
              type: string
          example: >-
            1f089d37-5ebe-6778-af59-99631cec7ab5,1f089d37-5ebc-6778-af59-99631cec7ab5
        - name: passName
          in: query
          description: Exact search by pass name (case-sensitive)
          required: false
          schema:
            type: string
            maxLength: 255
          example: VIP MEMBERSHIP PASS
        - name: status
          in: query
          description: Filter passes by status. Multiple values allowed.
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - Draft
                - Published
          example: Published,Draft
      responses:
        '200':
          description: Successfully retrieved wallet passes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BXPagedList'
              examples:
                Success Response:
                  summary: Paginated list of wallet passes
                  description: Success Response
                  value:
                    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
                        notificationHeader: BLUE PASS
                        passName: VIP MEMBERSHIP PASS
                        status: Published
                        passMetadata:
                          description: Exclusive VIP membership pass with premium benefits
                          organizationName: Premium Brands Inc
                          backgroundColor: '#4a32A8'
                          displayTextColor: '#FFFFFF'
                          topField:
                            key: tabKey
                            label: SEE OFFERS
                            value: Tab (...)
                          secondaryFields:
                            - key: auxiliaryFieldKey
                              label: Member Level
                              value: VIP Gold
                            - key: auxiliaryFieldKey2
                              label: Expires
                              value: Dec 31, 2025
                            - key: auxiliaryFieldKey3
                              label: Benefits
                              value: Premium Access
                          backFields:
                            - key: featured
                              label: Featured
                              value:
                                - link: https://premiumbrands.com/
                                  text: Visit Our Website
                            - key: connectWithUs
                              label: Connect
                              value:
                                - link: https://x.com/premiumbrands/
                                  text: X
                                - link: https://www.instagram.com/premiumbrands/
                                  text: Instagram
                              changeMessage: null
                            - key: dealsFromOurPartner
                              label: Deals from Partners
                              value:
                                - link: https://unblockedbrands.com
                                  text: Unblocked Brands
                          qrUrl: https://premiumbrands.com/vip-benefits
                          qrText: Scan for VIP benefits
                        uploadInfoList:
                          - fileName: icon.png
                            uploadKey: 1f089d37-8a1b-4c2d-9e3f-123456789abc
                          - fileName: logo.png
                            uploadKey: 1f089d37-8a1b-4c2d-9e3f-123456789def
                          - fileName: strip.png
                            uploadKey: 1f089d37-8a1b-4c2d-9e3f-123456789ghi
                    cursor: 1f089d37-5ebe-6778-af59-99631cec7ab5
                    hasMore: false
        '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.
components:
  schemas:
    BXPagedList:
      type: object
      properties:
        items:
          type: array
          items: {}
        cursor:
          type: string
        hasMore:
          type: boolean
    UnblockedApiError:
      type: object
      properties:
        txId:
          type: string
        timestamp:
          type: string
          format: date-time
        errorCode:
          type: string
        errorMessage:
          type: string
        context:
          type: object
          additionalProperties: {}
  securitySchemes:
    AccessToken:
      type: http
      description: Bearer token authentication
      scheme: bearer
      bearerFormat: JWT
    APIKey:
      type: apiKey
      description: API Key authentication
      name: api-key
      in: header

````