---
updatedAt: 2026-05-27T00:39:46.000Z
agentTools:
  projectIndex: https://docs.trybadge.com/llms.txt
---

# Get Pass Template

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Badge API",
    "version": "0"
  },
  "servers": [
    {
      "url": "https://api.trybadge.com/v0"
    }
  ],
  "security": [
    {
      "WorkspaceAuth": []
    }
  ],
  "tags": [
    {
      "name": "Pass Template"
    }
  ],
  "paths": {
    "/passTemplates/{passTemplateId}": {
      "get": {
        "operationId": "passTemplateGet",
        "tags": [
          "Pass Template"
        ],
        "summary": "Get Pass Template",
        "parameters": [
          {
            "in": "path",
            "name": "passTemplateId",
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "passTemplate"
                  ],
                  "properties": {
                    "passTemplate": {
                      "$ref": "#/components/schemas/PassTemplate"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "WorkspaceAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "RelevantAt": {
        "type": "string",
        "format": "date-time",
        "description": "ISO 8601 datetime string. Sets the event start time for Apple and Google Wallet relevance triggering. EVENT_TICKET pass templates only. This field does not support dynamic values.\n",
        "example": "2026-09-15T19:00:00Z"
      },
      "PassTemplate": {
        "type": "object",
        "required": [
          "id",
          "name",
          "archivedAt",
          "latestRevision"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "type": "string"
          },
          "archivedAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "previewData": {
            "$ref": "#/components/schemas/PassTemplatePreviewData"
          },
          "latestRevision": {
            "$ref": "#/components/schemas/PassTemplateRevision"
          },
          "publishedRevision": {
            "$ref": "#/components/schemas/PassTemplateRevision"
          }
        }
      },
      "PassTemplatePreviewData": {
        "type": "object",
        "required": [
          "description",
          "iconUri",
          "logoUri",
          "backgroundColor",
          "labelColor",
          "supportEmail"
        ],
        "properties": {
          "description": {
            "type": "string"
          },
          "iconUri": {
            "type": "string"
          },
          "logoUri": {
            "type": "string"
          },
          "backgroundColor": {
            "type": "string"
          },
          "labelColor": {
            "type": "string"
          },
          "supportEmail": {
            "type": "string",
            "format": "email"
          }
        }
      },
      "PassTemplateRevision": {
        "type": "object",
        "required": [
          "description",
          "logoUri",
          "backgroundColorHex",
          "textColorHex",
          "secondaryFields",
          "backFields",
          "locationMessages",
          "iosStoreIdentifiers",
          "smartTap",
          "appleVas",
          "appleFeaturedActions",
          "applePosterStyleEnabled",
          "posterSuppressHeaderDarkening"
        ],
        "properties": {
          "description": {
            "type": "string",
            "description": "The user facing name of this pass.\n"
          },
          "logoUri": {
            "type": "string"
          },
          "iconUri": {
            "type": "string"
          },
          "coverImageUri": {
            "type": "string"
          },
          "alternateCoverImageUri": {
            "type": "string"
          },
          "backgroundColorHex": {
            "$ref": "#/components/schemas/HexString"
          },
          "textColorHex": {
            "$ref": "#/components/schemas/HexString"
          },
          "applePosterStyleEnabled": {
            "type": "boolean"
          },
          "posterArtwork": {
            "type": "string"
          },
          "posterSuppressHeaderDarkening": {
            "type": "boolean"
          },
          "heading": {
            "type": "string"
          },
          "headerField": {
            "$ref": "#/components/schemas/RevisionField"
          },
          "secondaryFields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RevisionField"
            }
          },
          "footerFields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RevisionField"
            }
          },
          "barcodeType": {
            "$ref": "#/components/schemas/BarcodeType"
          },
          "barcodeData": {
            "type": "string"
          },
          "barcodeText": {
            "type": "string"
          },
          "backFields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RevisionBackField"
            }
          },
          "locationMessages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PassLocationMessage"
            }
          },
          "expiresAt": {
            "type": "string",
            "description": "ISO 8601 date time string or a dynamic value."
          },
          "relevantAt": {
            "$ref": "#/components/schemas/RelevantAt"
          },
          "webAppLinkUrl": {
            "type": "string",
            "format": "uri"
          },
          "webAppLinkIdentifier": {
            "type": "string"
          },
          "androidPackageName": {
            "type": "string"
          },
          "androidLinkDisplayText": {
            "type": "string"
          },
          "iosStoreIdentifiers": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "iosLaunchUrl": {
            "type": "string",
            "format": "uri"
          },
          "smartTap": {
            "type": "object",
            "properties": {
              "redemptionIssuerIds": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "redemptionValue": {
                "type": "string"
              }
            }
          },
          "appleVas": {
            "type": "object",
            "properties": {
              "encryptionPublicKey": {
                "type": "string"
              },
              "message": {
                "type": "string"
              },
              "requiresAuthentication": {
                "type": "boolean"
              }
            }
          },
          "appleFeaturedActions": {
            "type": "array",
            "maxItems": 2,
            "items": {
              "$ref": "#/components/schemas/AppleFeaturedAction"
            }
          }
        }
      },
      "HexString": {
        "type": "string",
        "pattern": "^#[a-fA-F0-9]{6}$"
      },
      "BarcodeType": {
        "type": "string",
        "enum": [
          "QR_CODE",
          "AZTEC",
          "CODE_128",
          "PDF_417"
        ]
      },
      "PassLocationMessage": {
        "type": "object",
        "required": [
          "message",
          "latitude",
          "longitude"
        ],
        "properties": {
          "name": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "latitude": {
            "type": "number",
            "format": "float"
          },
          "longitude": {
            "type": "number",
            "format": "float"
          }
        }
      },
      "RevisionField": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "body": {
            "type": "string"
          }
        }
      },
      "AppleFeaturedActionType": {
        "type": "string",
        "enum": [
          "addToBalance",
          "membershipBenefits",
          "order",
          "shop",
          "viewOffersRewards",
          "bookAppointment",
          "bookCar",
          "bookFlight",
          "bookStay",
          "viewSchedule",
          "listenToMusic",
          "watchTrailer"
        ]
      },
      "AppleFeaturedAction": {
        "type": "object",
        "required": [
          "identifier",
          "type",
          "url"
        ],
        "properties": {
          "identifier": {
            "type": "string",
            "minLength": 1
          },
          "type": {
            "$ref": "#/components/schemas/AppleFeaturedActionType",
            "description": "Refer to Apple's documentation on [featured actions](https://developer.apple.com/documentation/walletpasses/defining-the-metadata-of-your-wallet-pass#Add-featured-actions).\n"
          },
          "url": {
            "type": "string"
          }
        }
      },
      "RevisionBackField": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "link": {
            "type": "object",
            "required": [
              "url",
              "identifier"
            ],
            "properties": {
              "url": {
                "type": "string"
              },
              "identifier": {
                "type": "string",
                "description": "Used for tracking the same link across revisions.\n"
              }
            }
          }
        }
      }
    }
  }
}
```