API reference · Passes

List a pass's messages

GET/v1/passes/{serial}/messagesFree

The notifications a pass has been sent, newest first: one-off and broadcast ones, and with fields=true its fields' messages too.

Path

serialstringrequired

The pass's serialNumber.

Query

limit1 to 50

How many to return. Default 20. A page can run a little over: one update's messages are never split.

cursorstring

The previous page's nextCursor, for the older ones.

fields`true` or `false`

Also a field's message each time its value changed, as the lock screen showed it (%@ filled in). Default false.

Answer

200OK

kind is message (written: one-off or a broadcast's) or field. from is what sent it: person (the dashboard), api_key, broadcast, import, template (a template update) or demo; name is the API key's or template's name. by is the person behind it: who used the dashboard, started the broadcast, import or update, or created the key. Messages from before this was recorded (18 October 2026) are person or broadcast. total counts the written messages, on the first page only. nextCursor is null on the last page.

Errors

Every error has the same shape: see Errors.

Status	Code	When
400	`validation_error`	A bad `limit`, `cursor` or `fields`.
404	`not_found`	No pass with that serial number in this workspace.

Built from the pass's history, so it covers messages sent before this list existed, until the pass is erased.

Request

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

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

200 OK

{
  "messages": [
    {
      "kind": "message",
      "text": "Double points this weekend",
      "at": "2026-10-08T19:31:12.000Z",
      "from": "api_key",
      "by": "owner@example.com",
      "name": "Default"
    }
  ],
  "nextCursor": null,
  "total": 1
}