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

# Get a template

> Returns one template with its full definition.

Use this to find the field keys a pass needs, or to read a template's current design before you [update it](https://tapace.lk/docs/api-reference/templates/update.md).

**id** `string` *required*

The template ID, for example `tmpl_Q4vN8xT2mLr7KpZs3Wd1`.

## The template object

**id** `string`

Unique ID, starting with `tmpl_`.

**type** `string`

`generic`, `event_ticket`, `stamp_card` or `points_card`.

**name** `string`

The template's name, up to 100 characters.

**revision** `integer`

Goes up by one each time the design changes. Send it as `expectedRevision` when you update the template.

**archived** `boolean`

Archived templates can't issue new passes.

**requiredFields** `string[]`

Keys of the per-pass fields every new pass must include in `fieldValues`.

**requiredActions** `string[]`

Keys of the Featured Actions every new pass must include a link for in `featuredActions`. See [Issue a pass](https://tapace.lk/docs/api-reference/passes/issue.md).

**issuePlatforms** `object`

Which wallets new passes can use, as `{ "apple": true, "google": false }`. Passes already on a wallet keep it either way. Change it with [Update a template](https://tapace.lk/docs/api-reference/templates/update.md).

**definition** `object`

The full design: colours, images, barcode, platforms and fields. TapAce sets `platforms`: a wallet is `true` when `issuePlatforms` offers it or an active pass in test or live uses it, and that wallet's design must then be complete. Each field has a `key`, a `label`, a `binding` and a `required` flag. The binding is `shared`, `perPass`, `event` (the value comes from the template's [event details](https://tapace.lk/docs/api-reference/templates/get-event.md)) or `stamps`.

**createdAt** `string`

When the template was created.

**updatedAt** `string`

When the template last changed.

```bash cURL theme={null}
curl https://api.tapace.lk/v1/templates/tmpl_Q4vN8xT2mLr7KpZs3Wd1 \
  -H "Authorization: Bearer $TAPACE_API_KEY"
```

```json 200 theme={null}
{
  "object": "template",
  "id": "tmpl_Q4vN8xT2mLr7KpZs3Wd1",
  "type": "generic",
  "name": "Gold membership",
  "revision": 3,
  "archived": false,
  "requiredFields": ["memberName"],
  "requiredActions": [],
  "issuePlatforms": { "apple": true, "google": true },
  "createdAt": "2026-10-01T09:00:00.000Z",
  "updatedAt": "2026-10-12T15:20:00.000Z",
  "definition": {
    "schemaVersion": 1,
    "type": "generic",
    "description": "Gold membership card",
    "organizationName": "FORM Fitness",
    "colors": { "background": "#111827", "foreground": "#ffffff" },
    "platforms": { "apple": true, "google": true },
    "images": { "icon": "asset_Xr9Lm2Qv7Tn4Kp8Zs1Wd" },
    "config": {
      "fields": {
        "header": [],
        "primary": [
          { "key": "memberName", "label": "Member", "binding": "perPass", "required": true }
        ],
        "secondary": [
          { "key": "points", "label": "Points", "binding": "perPass", "required": false }
        ],
        "auxiliary": [],
        "back": []
      }
    }
  }
}
```


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