API reference · Passes

Get a pass's fields

GET/v1/passes/{serial}/bodyFree

Its current fields, as you'd send them to update it, placeholders filled in.

Path

serialstringrequired

The pass's serialNumber.

Answer

200OK

Errors

Every error has the same shape: see Errors.

Status	Code	When
404	`not_found`	No pass with that serial number in this workspace.

To change one field, get these, change it and send them all back with Update a pass.

Request

curl "https://api.walletpassapi.com/v1/passes/9f904677-e06d-4b0f-8404-878ff1066f88/body" \
  -H "Authorization: Bearer $WALLET_API_KEY"

const res = await fetch("https://api.walletpassapi.com/v1/passes/9f904677-e06d-4b0f-8404-878ff1066f88/body", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.WALLET_API_KEY}`,
  },
});
const data = await res.json();

import os

import requests

res = requests.get(
    "https://api.walletpassapi.com/v1/passes/9f904677-e06d-4b0f-8404-878ff1066f88/body",
    headers={"Authorization": f"Bearer {os.environ['WALLET_API_KEY']}"},
)
data = res.json()

<?php

$ch = curl_init("https://api.walletpassapi.com/v1/passes/9f904677-e06d-4b0f-8404-878ff1066f88/body");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("WALLET_API_KEY"),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

200 OK

{
  "organizationName": "Acme Coffee",
  "logoText": "Acme",
  "style": "loyalty",
  "primaryFields": [
    {
      "key": "points",
      "label": "Points",
      "value": "120",
      "changeMessage": "You now have %@ points"
    }
  ],
  "barcodeValue": "MEMBER-1042",
  "barcodeFormat": "QR",
  "externalId": "crm-1042",
  "latestMessage": {
    "label": "Latest message",
    "value": "No messages yet."
  },
  "headerFields": [],
  "secondaryFields": [],
  "backFields": [],
  "footerFields": [],
  "locations": [],
  "featuredActions": [],
  "sharingProhibited": true
}