API reference · Passes
List passes
GET/v1/passesFreeYour workspace's passes, newest first, found by any text in them and filtered by their state.
Query
qstringText 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 · revokedOnly passes in this state.
issuerstringOnly passes signed with this set: its slug, org:<slug> for your organization's, or platform for test passes.
createdFromdateMade on or after this day (YYYY-MM-DD, UTC).
createdTodateMade on or before this day.
appleInstalledtrue · falseOn at least one Apple device, or on none.
googleSavedtrue · falseSaved to Google Wallet, or not.
templatestringMade from this template (its slug).
templateOutdatedtrue · falseOn an older version of its template, or on the latest.
limit1 to 100How many to return. Default 50, at most 100.
cursorstringnextCursor from the page before, for the next page.
page1 to 10,000A 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.
| Status | Code | When |
|---|---|---|
| 400 | validation_error | A filter isn't valid, or both page and cursor are sent. |
| 400 | invalid_cursor | The cursor isn't one this endpoint returned. |
| 422 | unknown_issuer | No issuer with that slug here. |