Search and filter Wallet Passes
curl --request GET \
--url https://api.ubpass.co/v1/wallet-pass \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ubpass.co/v1/wallet-pass"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ubpass.co/v1/wallet-pass', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ubpass.co/v1/wallet-pass",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ubpass.co/v1/wallet-pass"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ubpass.co/v1/wallet-pass")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ubpass.co/v1/wallet-pass")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
}{
"txId": "Root=1-68d3693c-26a3db2278c7668f5e086711",
"timestamp": "24-09-2025 03:45:00",
"errorCode": "UNAUTHORIZED",
"errorMessage": "UNAUTHORIZED."
}Passport - Passes
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
cursorparameter for next page navigation limitcontrols page size (default: 20, max: 20)- Response includes
itemsarray,cursor, andhasMorefields
GET
/
wallet-pass
Search and filter Wallet Passes
curl --request GET \
--url https://api.ubpass.co/v1/wallet-pass \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ubpass.co/v1/wallet-pass"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ubpass.co/v1/wallet-pass', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ubpass.co/v1/wallet-pass",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ubpass.co/v1/wallet-pass"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ubpass.co/v1/wallet-pass")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ubpass.co/v1/wallet-pass")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
}{
"txId": "Root=1-68d3693c-26a3db2278c7668f5e086711",
"timestamp": "24-09-2025 03:45:00",
"errorCode": "UNAUTHORIZED",
"errorMessage": "UNAUTHORIZED."
}Authorizations
AccessTokenAPIKey
Bearer token authentication
Headers
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
Search keyword to filter passes by name (case-insensitive)
Maximum string length:
255Pagination cursor for fetching the next set of results. Use the 'cursor' value from the previous response.
Number of passes to return per page (1-20, max 20)
Required range:
1 <= x <= 20Include pass asset URLs (images) in the response
Return only basic pass information (summary mode)
Filter by specific pass ID
Pattern:
^[a-zA-Z0-9-_]+$Filter by a list of pass IDs
Exact search by pass name (case-sensitive)
Maximum string length:
255Filter passes by status. Multiple values allowed.
Available options:
Draft, Published