API reference · Templates

Get a template

GET/v1/templates/{slug}Free

A template, its latest update of its passes, and what updating them would cost now.

Path

slugstringrequired

The template's slug. org:<slug> for one your organization shares with this workspace (those can only be read).

Answer

200OK

update is the latest update of its passes, or null. preview is what updating its passes would do: outdated passes at one operation each, against operations.remaining (null when nothing stops it, or when what's left is a larger organization's to know: a workspace's key is told only its own limit). Both are null for an organization's template.

Errors

Every error has the same shape: see Errors.

Status	Code	When
404	`not_found`	No template with that slug here.

Request

curl "https://api.walletpassapi.com/v1/templates/gold-member" \
  -H "Authorization: Bearer $WALLET_API_KEY"

const res = await fetch("https://api.walletpassapi.com/v1/templates/gold-member", {
  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/templates/gold-member",
    headers={"Authorization": f"Bearer {os.environ['WALLET_API_KEY']}"},
)
data = res.json()

<?php

$ch = curl_init("https://api.walletpassapi.com/v1/templates/gold-member");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("WALLET_API_KEY"),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

200 OK

{
  "template": {
    "slug": "gold-member",
    "name": "Gold member",
    "design": {
      "organizationName": "Acme Coffee",
      "logoText": "Acme",
      "style": "loyalty",
      "primaryFields": [
        {
          "key": "points",
          "label": "Points",
          "value": "{{points}}",
          "changeMessage": "You now have %@ points"
        }
      ],
      "secondaryFields": [
        {
          "key": "member",
          "label": "Member",
          "value": "{{holder.name}}"
        }
      ],
      "barcodeValue": "{{member_id}}",
      "barcodeFormat": "QR"
    },
    "placeholders": [
      {
        "key": "points",
        "type": "number",
        "required": true
      },
      {
        "key": "member_id",
        "label": "Member ID",
        "type": "text",
        "required": true
      }
    ],
    "keys": [
      "points",
      "holder.name",
      "member_id"
    ],
    "holderRequired": {
      "name": true,
      "email": false
    },
    "issuer": null,
    "installHeadline": null,
    "version": 2,
    "passes": 1200,
    "outdated": 1200,
    "organization": false,
    "createdAt": "2026-10-08T19:31:12.000Z",
    "updatedAt": "2026-10-08T19:31:12.000Z"
  },
  "update": null,
  "preview": {
    "passes": 1200,
    "outdated": 1200,
    "platformPasses": 0,
    "operations": {
      "scope": "organization",
      "used": 18342,
      "allowance": 100000,
      "remaining": 81658
    },
    "platform": {
      "used": 0,
      "allowance": 1000,
      "remaining": 1000
    }
  }
}