API reference · Passes

Export passes as CSV

GET/v1/passes/exportFree

The passes a search finds, as a spreadsheet: one row per pass, one column per field.

Query

qstring

Text in the pass (labels, values, names, the barcode), its serial number or external ID, or its holder's name or email. Not case-sensitive.

statusactive · revoked

Only passes in this state.

issuerstring

Only passes signed with this set: its slug, org:<slug> for your organization's, or platform for test passes.

createdFromdate

Made on or after this day (YYYY-MM-DD, UTC).

createdTodate

Made on or before this day.

appleInstalledtrue · false

On at least one Apple device, or on none.

googleSavedtrue · false

Saved to Google Wallet, or not.

templatestring

Made from this template (its slug).

templateOutdatedtrue · false

On an older version of its template, or on the latest.

Answer

200OK

UTF-8 with a byte-order mark, so Excel reads accents correctly. Columns: serialNumber, externalId, status, issuer, organizationName, logoText, description, barcodeFormat, barcodeValue, expiresAt, latestMessage, appleDevices, googleWallet, createdAt, updatedAt, then one per field, headed by its label.

Errors

Every error has the same shape: see Errors.

Status	Code	When
422	`export_too_large`	More than 100,000 passes match: narrow the search.

Request

curl "https://api.walletpassapi.com/v1/passes/export?status=active" \
  -H "Authorization: Bearer $WALLET_API_KEY" \
  -o passes.csv

const res = await fetch("https://api.walletpassapi.com/v1/passes/export?status=active", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.WALLET_API_KEY}`,
  },
});
const csv = await res.text();

import os

import requests

res = requests.get(
    "https://api.walletpassapi.com/v1/passes/export",
    headers={"Authorization": f"Bearer {os.environ['WALLET_API_KEY']}"},
    params={
        "status": "active",
    },
)
csv = res.text

<?php

$ch = curl_init("https://api.walletpassapi.com/v1/passes/export?status=active");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("WALLET_API_KEY"),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$csv = curl_exec($ch);

200 OK

serialNumber,externalId,status,issuer,organizationName,logoText,…,Points
9f904677-e06d-4b0f-8404-878ff1066f88,crm-1042,active,default,Acme Coffee,Acme,…,135