API reference · Passes

Get a pass's design and values

GET/v1/passes/{serial}/designFree

For a pass with placeholders: its design as written, with the placeholders, its own values and its holder.

Path

serialstringrequired

The pass's serialNumber.

Answer

200OK

design is null for a pass without placeholders.

Errors

Every error has the same shape: see Errors.

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

Request

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

const res = await fetch("https://api.walletpassapi.com/v1/passes/9f904677-e06d-4b0f-8404-878ff1066f88/design", {
  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/design",
    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/design");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("WALLET_API_KEY"),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

200 OK

{
  "design": {
    "organizationName": "Acme Coffee",
    "logoText": "Acme",
    "primaryFields": [
      {
        "key": "points",
        "label": "Points",
        "value": "{{points}}"
      }
    ]
  },
  "data": {
    "points": "120"
  },
  "holder": {
    "name": "Priya Shah",
    "email": "priya@example.com"
  },
  "template": {
    "slug": "gold-member",
    "name": "Gold member",
    "version": 3,
    "current": true,
    "placeholders": [
      {
        "key": "points",
        "type": "number",
        "required": true
      }
    ],
    "holderRequired": {
      "name": true,
      "email": false
    }
  }
}