WalletPassAPI Docs

API reference · Passes

List passes

GET/v1/passesFree

Your workspace's passes, newest first, found by any text in them and filtered by their state.

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.

limit1 to 100

How many to return. Default 50, at most 100.

cursorstring

nextCursor from the page before, for the next page.

page1 to 10,000

A numbered page instead of a cursor: the answer adds total and page. Not with cursor. See Paging.

Answer

200OK

nextCursor is null on the last page. A pass never moves between pages while you page through, even as new ones are made.

Errors

Every error has the same shape: see Errors.

StatusCodeWhen
400validation_errorA filter isn't valid, or both page and cursor are sent.
400invalid_cursorThe cursor isn't one this endpoint returned.
422unknown_issuerNo issuer with that slug here.