Skip to main content
GET
/
wallet-pass
Search and filter Wallet Passes
curl --request GET \
  --url https://api.ubpass.co/v1/wallet-pass \
  --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",
      "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
}

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 passes 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 passes to return per page (1-20, max 20)

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

Include pass asset URLs (images) in the response

​
summary
boolean

Return only basic pass information (summary mode)

​
id
string

Filter by specific pass ID

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

Filter by a list of pass IDs

​
passName
string

Exact search by pass name (case-sensitive)

Maximum string length: 255
​
status
enum<string>[]

Filter passes by status. Multiple values allowed.

Available options:
Draft,
Published

Response

Successfully retrieved wallet passes

​
items
any[]
​
cursor
string
​
hasMore
boolean