Skip to main content
GET
/
wallet-pass-location
Search and filter Wallet Pass Locations
curl --request GET \
  --url https://api.ubpass.co/v1/wallet-pass-location \
  --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",
      "name": "TORONTO MALL LOCATION",
      "enabled": true,
      "latitude": 43.798327702071944,
      "longitude": -79.24175240232819,
      "relevantText": "Welcome to Toronto Premium Outlets",
      "walletPass": {
        "id": "1f07ee39-d750-6276-aff4-07a599527878"
      }
    }
  ],
  "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

Query Parameters

query
string

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

Maximum length: 255
name
string

Exact search by location name (case-sensitive)

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

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

Filter locations by wallet pass serial numbers. Multiple values allowed.

ids
string[]

Filter by location ID list

id
string

Filter by specific location ID

Response

Successfully retrieved wallet pass locations

items
any[]
cursor
string
hasMore
boolean