Get Dynamic Pass Template API

Overview

The Get Dynamic Pass Template API allows you to retrieve detailed information about a specific dynamic pass template. This includes the complete template configuration, dynamic field placeholders, and design elements. This endpoint is useful for reviewing template settings, debugging template issues, or displaying template information in your application.

🔗 User Group Association

The configuration returned here is the blueprint applied to every pass issued from this template. Each template is linked to a user group that holds those customers.

Base URL

https://app.addtowallet.co

GET/api/dynamicPass/template/:dynamicpassId

Path Parameters

dynamicpassId (string, required): The unique identifier of the dynamic pass template to retrieve

Authentication

All API requests must include your API key in the request headers:

"apikey": "your-api-key-here"

Request

This is a GET request that requires no request body. The template ID is specified in the URL path.

GET /api/dynamicPass/template/686d0d92c2f0bc5cdf25c834
apikey: your-api-key-here

Response

Upon successful retrieval, the API returns a JSON object containing the complete template configuration:

Template Configuration

cardType (string): The type of card/pass (e.g., "Dynamic Card")
cardTitle (string): Main title displayed on the pass (may contain dynamic placeholders)
header (string): Header text on the pass (may contain dynamic placeholders)
subheader (string): Secondary header text displayed below the main header (may contain dynamic placeholders)
textModulesData (array): Array of text modules with headers and body content
linksModuleData (array): Array of clickable links with descriptions and URIs
barcodeType (string): Type of barcode (QR_CODE, PDF417, etc.)
hexBackgroundColor (string): Background color in hex format
heroImage (string): URL of the main image displayed on the pass
thumbnailImage (string, optional): Apple square thumbnail URL when event-ticket layout is active
backgroundImage (string, optional): Apple full-card background URL (optional; layout also activates from thumbnail alone)
applePassLayout (string, read-only): Set to eventTicket when thumbnail/background images are present — do not send this field on create/update

Understanding Dynamic Field Placeholders

String values may contain placeholders like {employeeName} that are substituted with each customer's data when a pass is issued. See Create Template → Dynamic Field Placeholders for the placeholder syntax.

Response Example

{
  "cardType": "Dynamic Card",
  "passType": "generic",
  "genericType": "GENERIC_TYPE_UNSPECIFIED",
  "logoUrl": "https://s3.amazonaws.com/i.addtowallet.co/assets/realestatelogo.png",
  "cardTitle": "{org}",
  "header": "{name}",
  "subheader": "{title}",
  "textModulesData": [
    {
      "id": "r1start",
      "header": "Mobile",
      "body": "+1 8888888888"
    },
    {
      "id": "r1end",
      "header": "Email",
      "body": "{email}"
    }
  ],
  "linksModuleData": [
    {
      "id": "r1",
      "description": "Call Us",
      "uri": "tel:+1 8287489293"
    },
    {
      "id": "r2",
      "description": "Email Us",
      "uri": "mailto:[email protected]"
    },
    {
      "id": "r3",
      "description": "Visit our website",
      "uri": "https://app.addtowallet.co"
    },
    {
      "id": "r4",
      "description": "Visit our office",
      "uri": "geo:https://maps.google.com/?q=123+Main+Street,+Anytown,+CA"
    }
  ],
  "barcodeType": "QR_CODE",
  "barcodeValue": "",
  "barcodeAltText": "",
  "hexBackgroundColor": "#9d3434",
  "appleFontColor": "#FFFFFF",
  "changedAppleFontColor": false,
  "heroImage": "https://s3.amazonaws.com/i.addtowallet.co/assets/realestatehero.png",
  "stateType": "ACTIVE"
}

💡 Template Usage

To issue passes from this template, add customers to its group via Add User — each customer's values fill the placeholders above.

Error Code	Description
400	BAD_REQUEST - Missing or invalid dynamicPassId parameter
401	UNAUTHORIZED - Valid API key required
404	NOT_FOUND - Template not found or insufficient permissions
500	SERVER_ERROR - Database error or unexpected server issue