GET
/
wallet-pass
/
{id}
Get Pass Details
curl --request GET \
  --url https://api.ubpass.co/v1/wallet-pass/{id} \
  --header 'api-key: <api-key>'
[
  {
    "id": "<string>",
    "createdTime": "2025-05-13T15:07:15.036Z",
    "updatedTime": "2025-05-13T15:07:15.036Z",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "workspaceId": "<string>",
    "passName": "My Wallet Pass",
    "passMetadata": {
      "description": "<string>",
      "organizationName": "<string>",
      "backgroundColor": "<string>",
      "displayTextColor": "<string>",
      "topField": {
        "key": "<string>",
        "label": "<string>",
        "value": "<string>",
        "changeMessage": "<string>"
      },
      "secondaryFields": [
        {
          "key": "<string>",
          "label": "<string>",
          "value": "<string>",
          "changeMessage": "<string>"
        }
      ],
      "backFields": [
        {
          "key": "<string>",
          "label": "<string>",
          "value": [
            {
              "text": "<string>",
              "link": "<string>",
              "slug": "<string>",
              "shortLinkValue": "<string>",
              "shortLinkId": "<string>",
              "utmSource": "<string>"
            }
          ],
          "changeMessage": "<string>"
        }
      ],
      "qrUrl": "<string>",
      "qrText": "<string>",
      "locations": [
        {
          "id": "<string>",
          "createdTime": "2025-05-13T15:07:15.036Z",
          "updatedTime": "2025-05-13T15:07:15.036Z",
          "createdBy": "<string>",
          "updatedBy": "<string>",
          "workspaceId": "<string>",
          "name": "Main Store",
          "enabled": true,
          "latitude": 37.7749,
          "longitude": -122.4194,
          "altitude": 10.5,
          "relevantText": "You are near Main Store!"
        }
      ],
      "appDeepLinks": {
        "appleDeepLinkData": {
          "appStoreId": "<string>",
          "launchUrl": "<string>"
        },
        "googleDeepLinkData": {
          "androidPackageName": "<string>",
          "webAppUrl": "<string>",
          "displayText": "<string>"
        }
      },
      "userDeepLink": {
        "appType": "Website",
        "inputLink": "<string>",
        "appleAppStoreUrl": "<string>",
        "launchUrl": "<string>",
        "googlePlayStoreUrl": "<string>"
      }
    },
    "uploadInfoList": [
      {
        "fileName": "logo.png, icon.png, strip.png, footer.png",
        "uploadKey": "<string>",
        "url": "<string>"
      }
    ],
    "passLink": "<string>",
    "notificationHeader": "<string>",
    "account": {
      "id": "<string>",
      "createdTime": "2025-05-13T15:07:15.036Z",
      "updatedTime": "2025-05-13T15:07:15.036Z",
      "createdBy": "<string>",
      "updatedBy": "<string>",
      "workspaceId": "<string>",
      "name": "<string>",
      "clientContact": "<string>",
      "clientContactDetails": "<string>"
    },
    "appleIssuedCount": 123,
    "googleIssuedCount": 123,
    "totalIssuedCount": 123,
    "appleActiveCount": 123,
    "googleActiveCount": 123,
    "totalActiveCount": 123,
    "passLinkSlug": "<string>",
    "googlePassLink": "<string>",
    "status": "Draft, Published"
  }
]

Authorizations

​
api-key
string
header
required

API Key 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

Path Parameters

​
id
string
required

wallet pass id

Response

Success

​
passName
string
required

Name of the pass, the name has to be unique within the workspace.

Example:

"My Wallet Pass"

​
passMetadata
object
required

Pass metadata.

​
id
string
​
createdTime
string<date-time>

The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.

Example:

"2025-05-13T15:07:15.036Z"

​
updatedTime
string<date-time>

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
string

The user who created the entity.

​
updatedBy
string

The user who last updated the entity.

​
workspaceId
string

Workspace the pass belongs to.

​
uploadInfoList
object[]

Wallet pass images. each pass has to have a logo, icon, and strip images in png format. footer.png is optional.

​
passLink
string

The link where passes can be downloaded. This link will be generated after passes are created.

​
notificationHeader
string

This is used for Apple passes. The notification header is displayed on the lock screen when a notification is sent to the pass.

​
account
object

Account which the pass belongs to. If it's not provided the system will automatically use the default account for the workspace.

​
appleIssuedCount
integer

Total number of users who have added this pass to their Apple Wallets

​
googleIssuedCount
integer

Total number of users who have added this pass to their Google Wallets

​
totalIssuedCount
integer

Total number of users who have added this pass to their wallets (Apple + Google)

​
appleActiveCount
integer

Total number of users who have added this pass to their Apple Wallets and have not removed it

​
googleActiveCount
integer

Total number of users who have added this pass to their Google Wallets and have not removed it

​
totalActiveCount
integer

Total number of users who have added this pass to their wallets (Apple + Google) and have not removed it

​
passLinkSlug
string

Slug to be used for the pass link. This is used to generate the pass link, if not provided the system will generate a random slug.

​
googlePassLink
string

Raw link to Google Pass. This link is provided by Google API.

​
status
enum<string>

Pass status

Available options:
Draft,
Published
Example:

"Draft, Published"