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.

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:

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"
}