Get a pass

curl https://api.tapace.lk/v1/passes/pass_7hGk2LmQ9xVt4RnB8cYe \
  -H "Authorization: Bearer $TAPACE_API_KEY"

{
  "object": "pass",
  "id": "pass_7hGk2LmQ9xVt4RnB8cYe",
  "shortId": "6BkJLsso1xyB",
  "templateId": "tmpl_Q4vN8xT2mLr7KpZs3Wd1",
  "templateName": "Gold membership",
  "templateRevision": 3,
  "environment": "test",
  "status": "active",
  "source": "api",
  "holderName": "Nimal Perera",
  "holderEmail": "nimal@example.com",
  "platforms": { "apple": true, "google": true },
  "signing": {
    "appleCertificateId": "demo",
    "applePassTypeIdentifier": null,
    "googleIssuerId": "demo"
  },
  "fieldValues": { "memberName": "Nimal Perera", "points": 150 },
  "distributionUrl": "https://pass.tapace.lk/6BkJLsso1xyB",
  "artifacts": {
    "apple": { "ready": true },
    "google": { "ready": true }
  },
  "walletUpdatedAt": "2026-10-13T10:30:00.000Z",
  "createdAt": "2026-10-13T10:00:00.000Z",
  "updatedAt": "2026-10-13T10:30:00.000Z",
  "voidedAt": null
}

{
  "error": {
    "type": "not_found_error",
    "message": "Pass not found."
  },
  "requestId": "req_8f3a2c1d9e7b6a54"
}

GET

passes

{id}

curl https://api.tapace.lk/v1/passes/pass_7hGk2LmQ9xVt4RnB8cYe \
  -H "Authorization: Bearer $TAPACE_API_KEY"

{
  "object": "pass",
  "id": "pass_7hGk2LmQ9xVt4RnB8cYe",
  "shortId": "6BkJLsso1xyB",
  "templateId": "tmpl_Q4vN8xT2mLr7KpZs3Wd1",
  "templateName": "Gold membership",
  "templateRevision": 3,
  "environment": "test",
  "status": "active",
  "source": "api",
  "holderName": "Nimal Perera",
  "holderEmail": "nimal@example.com",
  "platforms": { "apple": true, "google": true },
  "signing": {
    "appleCertificateId": "demo",
    "applePassTypeIdentifier": null,
    "googleIssuerId": "demo"
  },
  "fieldValues": { "memberName": "Nimal Perera", "points": 150 },
  "distributionUrl": "https://pass.tapace.lk/6BkJLsso1xyB",
  "artifacts": {
    "apple": { "ready": true },
    "google": { "ready": true }
  },
  "walletUpdatedAt": "2026-10-13T10:30:00.000Z",
  "createdAt": "2026-10-13T10:00:00.000Z",
  "updatedAt": "2026-10-13T10:30:00.000Z",
  "voidedAt": null
}

{
  "error": {
    "type": "not_found_error",
    "message": "Pass not found."
  },
  "requestId": "req_8f3a2c1d9e7b6a54"
}

string

required

The pass ID, for example pass_7hGk2LmQ9xVt4RnB8cYe.

The pass object

string

Unique ID, starting with pass_.

string

A short 12-character handle, used in the pass’s link and handy for support.

string

The template the pass was issued from.

string

The template’s current name.

integer

The template revision the pass uses.

string

test or live.

string

active or voided.

string

api or dashboard: where the pass was issued.

string | null

The holder’s name.

string | null

The holder’s email address.

object

apple and google booleans: the wallets the pass was issued for.

object

The Apple certificate (appleCertificateId, applePassTypeIdentifier) and Google issuer (googleIssuerId) that sign the pass. Test passes use demo.

object

Current values of the per-pass fields, keyed by field key.

string

The permanent link where the holder adds the pass. See Deliver passes.

object

Whether the pass can be added to each wallet right now. apple.ready and google.ready are booleans, and reason explains a false.

string

When the pass last changed in a way wallets can see.

string

When the pass was issued.

string

When the pass was last changed.

string | null

When the pass was voided.

The response also includes editableFields, editableBarcode and preview, which the dashboard uses to show and edit the pass.

curl https://api.tapace.lk/v1/passes/pass_7hGk2LmQ9xVt4RnB8cYe \
  -H "Authorization: Bearer $TAPACE_API_KEY"

{
  "object": "pass",
  "id": "pass_7hGk2LmQ9xVt4RnB8cYe",
  "shortId": "6BkJLsso1xyB",
  "templateId": "tmpl_Q4vN8xT2mLr7KpZs3Wd1",
  "templateName": "Gold membership",
  "templateRevision": 3,
  "environment": "test",
  "status": "active",
  "source": "api",
  "holderName": "Nimal Perera",
  "holderEmail": "nimal@example.com",
  "platforms": { "apple": true, "google": true },
  "signing": {
    "appleCertificateId": "demo",
    "applePassTypeIdentifier": null,
    "googleIssuerId": "demo"
  },
  "fieldValues": { "memberName": "Nimal Perera", "points": 150 },
  "distributionUrl": "https://pass.tapace.lk/6BkJLsso1xyB",
  "artifacts": {
    "apple": { "ready": true },
    "google": { "ready": true }
  },
  "walletUpdatedAt": "2026-10-13T10:30:00.000Z",
  "createdAt": "2026-10-13T10:00:00.000Z",
  "updatedAt": "2026-10-13T10:30:00.000Z",
  "voidedAt": null
}

{
  "error": {
    "type": "not_found_error",
    "message": "Pass not found."
  },
  "requestId": "req_8f3a2c1d9e7b6a54"
}

Getting started

Basics

Guides

API keys

Passes

Templates

Assets

The pass object

​The pass object

The pass object