> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tapace.lk/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a pass

> Returns one pass with its current values and wallet readiness.

<ParamField path="id" type="string" required>
  The pass ID, for example `pass_7hGk2LmQ9xVt4RnB8cYe`.
</ParamField>

## The pass object

<ResponseField name="id" type="string">
  Unique ID, starting with `pass_`.
</ResponseField>

<ResponseField name="shortId" type="string">
  A short 12-character handle, used in the pass's link and handy for support.
</ResponseField>

<ResponseField name="templateId" type="string">
  The template the pass was issued from.
</ResponseField>

<ResponseField name="templateName" type="string">
  The template's current name.
</ResponseField>

<ResponseField name="templateRevision" type="integer">
  The template revision the pass uses.
</ResponseField>

<ResponseField name="environment" type="string">
  `test` or `live`.
</ResponseField>

<ResponseField name="status" type="string">
  `active` or `voided`.
</ResponseField>

<ResponseField name="source" type="string">
  `api` or `dashboard`: where the pass was issued.
</ResponseField>

<ResponseField name="holderName" type="string | null">
  The holder's name.
</ResponseField>

<ResponseField name="holderEmail" type="string | null">
  The holder's email address.
</ResponseField>

<ResponseField name="platforms" type="object">
  `apple` and `google` booleans: the wallets the pass was issued for.
</ResponseField>

<ResponseField name="signing" type="object">
  The Apple certificate (`appleCertificateId`, `applePassTypeIdentifier`) and Google issuer (`googleIssuerId`) that sign the pass. Test passes use `demo`.
</ResponseField>

<ResponseField name="fieldValues" type="object">
  Current values of the per-pass fields, keyed by field key.
</ResponseField>

<ResponseField name="distributionUrl" type="string">
  The permanent link where the holder adds the pass. See [Deliver passes](/guides/deliver-passes).
</ResponseField>

<ResponseField name="artifacts" type="object">
  Whether the pass can be added to each wallet right now. `apple.ready` and `google.ready` are booleans, and `reason` explains a `false`.
</ResponseField>

<ResponseField name="walletUpdatedAt" type="string">
  When the pass last changed in a way wallets can see.
</ResponseField>

<ResponseField name="createdAt" type="string">
  When the pass was issued.
</ResponseField>

<ResponseField name="updatedAt" type="string">
  When the pass was last changed.
</ResponseField>

<ResponseField name="voidedAt" type="string | null">
  When the pass was voided.
</ResponseField>

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

<RequestExample>
  ```bash cURL theme={null}
  curl https://api.tapace.lk/v1/passes/pass_7hGk2LmQ9xVt4RnB8cYe \
    -H "Authorization: Bearer $TAPACE_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "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
  }
  ```

  ```json 404 theme={null}
  {
    "error": {
      "type": "not_found_error",
      "message": "Pass not found."
    },
    "requestId": "req_8f3a2c1d9e7b6a54"
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.