Skip to main content
New to Corsair? See API access, authentication, and error handling.

Passes

activeHistory

passes.activeHistory Read the history of active and inactive passes of a template Risk: read
Input Output: object[]

create

passes.create Create a pass from a pass template with personalised properties Risk: write
Input Property keys are the template’s property names or property IDs; templates.fields lists both. The answer is the created pass. Output

delete

passes.delete Delete a pass Risk: destructive · Irreversible
Input Answers a success envelope. Output

enableDownload

passes.enableDownload Enable the download of a pass Risk: write
Input Output

get

passes.get Read one pass by UID, barcode value or user-provided ID Risk: read
Input passUid accepts the pass UID, the barcode value or a user-provided ID. Output

list

passes.list List the passes of a pass template, paged by cursor and date Risk: read
Input Cursor paging: pass lastIdOfPriorPage and lastCreatedOnOfPriorPage from the prior page along with start and pageSize. Output

pushNotification

passes.pushNotification Push a notification message to one pass holder; the message goes out and cannot be recalled Risk: destructive · Irreversible
Input Output
passes.search Search the passes of a template by content Risk: read
Input Output: object[]

sendEmail

passes.sendEmail Send the pass to an email address; the email goes out and cannot be recalled Risk: destructive · Irreversible
Input Output

statistics

passes.statistics Read pass usage statistics of a template by day, week or month Risk: read
Input Output: empty object

update

passes.update Update pass properties or mark the pass voided or not voided Risk: write
Input Answers 204 with no body; the voided flag marks or unmarks a pass as voided. Output

uris

passes.uris Read the resource URIs of a pass Risk: read
Input Output: empty object

Templates

copy

templates.copy Copy a pass template Risk: write
Input Output

delete

templates.delete Delete a pass template; the API refuses when scheduled tasks exist Risk: destructive · Irreversible
Input The API refuses with 400 while scheduled push notifications exist for the template. Output

fields

templates.fields Read the required and optional fields of a pass template Risk: read
Input The zapierStyle field list; use these keys to personalise passes. Output: object[]

list

templates.list List all pass templates of the account Risk: read
Input: empty object Output: object[]

movePass

templates.movePass Move a pass to a different template of the same project (API v2) Risk: write
Input API v2. Both templates must belong to the same project and share a signing certificate. Output

Webhooks

getPublicKey

webhooks.getPublicKey Read the PEM public key that verifies webhook payload signatures Risk: read
Input: empty object Returns the PEM public key the deliveries are signed with; store it with keys.set_webhook_signature so the plugin verifies deliveries. Output

list

webhooks.list List the active webhook subscriptions, including pull-mode entries Risk: read
Input: empty object Output: object[]

subscribe

webhooks.subscribe Subscribe a URL to a webhook event, optionally scoped to one template Risk: write
Input Events include pass_created, pass_updated, pass_voided, pushnotification_registered, pass_template_created, pass_template_updated and app_scan_created; pass_template scopes the subscription to one template, and signPayload defaults to true so deliveries can be verified; the target URL gets this account’s corsair_token, which the webhook handler requires. Output

unsubscribe

webhooks.unsubscribe Unsubscribe a webhook; deliveries stop until it is subscribed again Risk: destructive · Irreversible
Input Output