Locations that trigger lock-screen relevance in Apple and Google Wallet (Apple's locations, Google's merchantLocations). Combined with any pass-level locations when passes are issued from this template.
When true, the template is archived. No new passes can be created and all existing passes are voided.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Passform Docs","colors":{"primary":"#009485","light":"#19bea2","dark":"#00665c"},"logo":{"light":"https://mintcdn.com/passform/pcWZEUYGXmyjRGIQ/logo/logo-black.png?fit=max\u0026auto=format\u0026n=pcWZEUYGXmyjRGIQ\u0026q=85\u0026s=246ff0edaaabc72a37df70791750c3f5","dark":"https://mintcdn.com/passform/pcWZEUYGXmyjRGIQ/logo/logo-white.png?fit=max\u0026auto=format\u0026n=pcWZEUYGXmyjRGIQ\u0026q=85\u0026s=285fe61155165025a4cacd6dae78e96a"},"favicon":{"light":"https://mintcdn.com/passform/He9bSbndhY1Ja79s/logo/favicon-black.png?fit=max\u0026auto=format\u0026n=He9bSbndhY1Ja79s\u0026q=85\u0026s=19ab8cf19214726ea441f3aa74807264","dark":"https://mintcdn.com/passform/He9bSbndhY1Ja79s/logo/favicon-white.png?fit=max\u0026auto=format\u0026n=He9bSbndhY1Ja79s\u0026q=85\u0026s=01df01f6073dbc37e99c2e2e19970579"},"navbar":{"links":[{"href":"mailto:support@passform.io","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.passform.io"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/passform-io"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Support","icon":"envelope","href":"mailto:support@passform.io"},{"anchor":"LinkedIn","icon":"linkedin","href":"https://linkedin.com/company/passform-io"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"passform","hasAudioNarration":false,"actualSubdomain":"passform","customDomains":["docs.passform.io"],"gitSource":{"type":"github","owner":"my-shout","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac6c6f99e03268cffa71a9a","collectionId":"7614d89a-9633-48a5-ab1a-3a7d90b4124d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac6c6f99e03268cffa71a9a"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ac6c6f99e03268cffa71a9a","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API reference","count":24},{"language":"default","tag":"Endpoints","count":23},{"language":"default","tag":"Guides","count":15},{"language":"default","tag":"passes","count":11},{"language":"default","tag":"templates","count":6},{"language":"default","tag":"Integrations","count":3},{"language":"default","tag":"accounts","count":3},{"language":"default","tag":"Getting started","count":2},{"language":"default","tag":"Overview","count":1},{"language":"default","tag":"API Reference","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/templates/get-template","slug":"/api-reference/templates/get-template","pageMetadata":{"title":"Get template","description":"Gets the template for creating passes from the given id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{templateId}","href":"/api-reference/templates/get-template","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Gets the template for creating passes from the given id\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get template","description":"Gets the template for creating passes from the given id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{templateId}","href":"/api-reference/templates/get-template","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getTemplate","summary":"Get template","tags":["templates","mcp"],"description":"Gets the template for creating passes from the given id","parameters":["57ad9ce9-6d94-4a3d-9beb-6a30f4d1cae0","cac4205b-a961-4128-b94d-c92c05d8823b"],"security":["41c92773-f81b-430c-885a-279d49a14f69"],"responses":{"200":"497d4c50-8df1-4b69-a8af-62c80037dd52","401":"1080d5e3-9313-42f7-b938-6c406fe9ce2f","404":"b6f86eb5-296c-4c44-b0d3-825a898fa3bf"},"method":"get","type":"path","servers":["3488112f-d7e8-496d-b720-fee63c0f4059"],"path":"/v1/templates/{templateId}","baseUrlOptions":["https://api.passform.io"],"title":"Get template","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"57ad9ce9-6d94-4a3d-9beb-6a30f4d1cae0":{"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"},"in":"query","name":"accountId","required":false},"cac4205b-a961-4128-b94d-c92c05d8823b":{"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"in":"path","name":"templateId","required":true}},"responses":{"497d4c50-8df1-4b69-a8af-62c80037dd52":{"description":"Default Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Template","description":"A template is the basis of a pass it defines the appearance of a pass and properties that don't change between instances of passes.","required":["foregroundColor","backgroundColor","icon","logo","banner","title","issuerName","id","accountId"],"example":{"id":"drink_voucher","accountId":"LDvGjp645u6Q6t9pbvog","foregroundColor":"#FFFFF","backgroundColor":"#043A80","logo":"https://myshout.co/images/logo-white.svg","background":"https://myshout.co/images/backgrounds/image-62.jpg","icon":"https://myshout.co/images/favicon-150.png","title":"My Shout Drink Voucher","issuerName":"My Shout","sharingProhibited":false,"fields":[{"key":"voucher","label":"free drinks","value":"1"}],"backFields":[{"key":"terms","label":"Terms and Condictions","value":"https://myshout.co/terms"}]},"properties":{"foregroundColor":{"pattern":"^(#([a-fA-F0-9]{3}){1,2}|(rgb|rgba)(s*(d+%?s*,s*){2,3}(d+%?s*,?s*)d*.?d*s*))$","description":"(Apple and Web Only) A hex or rgb value providing the foreground color. This is used for font color","type":"string","isRequired":true,"uniqueKey":"oneOf.0.foregroundColor","typeLabel":"string"},"backgroundColor":{"pattern":"^(#([a-fA-F0-9]{3}){1,2}|(rgb|rgba)(s*(d+%?s*,s*){2,3}(d+%?s*,?s*)d*.?d*s*))$","description":"A hex or rgb value providing the foreground color","type":"string","isRequired":true,"uniqueKey":"oneOf.0.backgroundColor","typeLabel":"string"},"icon":{"description":"A url to an image of size X by Y.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.icon","typeLabel":"string"},"logo":{"description":"The icon but with text and doesnt need to be square","type":"string","isRequired":true,"uniqueKey":"oneOf.0.logo","typeLabel":"string"},"banner":{"description":"(Google, Apple Only) A url to an image of size X by Y. Also used in link previews.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.banner","typeLabel":"string"},"title":{"description":"The title displayed on the pass.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.title","typeLabel":"string"},"issuerName":{"description":"The name of the issuer.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.issuerName","typeLabel":"string"},"id":{"description":"Id is a unique identifier for the template","type":"string","isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string"},"accountId":{"description":"Account Id is the account the template belongs to","type":"string","isRequired":true,"uniqueKey":"oneOf.0.accountId","typeLabel":"string"},"labelColor":{"pattern":"^(#([a-fA-F0-9]{3}){1,2}|(rgb|rgba)(s*(d+%?s*,s*){2,3}(d+%?s*,?s*)d*.?d*s*))$","description":"(Apple Only) A hex or rgb value providing the label color. If unset then the foreground color is used.","type":"string","uniqueKey":"oneOf.0.labelColor","typeLabel":"string"},"background":{"description":"(Web Only) A url to an image that is displayed as the background. If this is not provided then backgroundColor is used.","type":"string","uniqueKey":"oneOf.0.background","typeLabel":"string"},"sharingProhibited":{"description":"Disable sharing from mobile wallets","type":"boolean","uniqueKey":"oneOf.0.sharingProhibited","typeLabel":"boolean"},"locations":{"maxItems":10,"description":"Locations that trigger lock-screen relevance in Apple and Google Wallet (Apple's locations, Google's merchantLocations). Combined with any pass-level locations when passes are issued from this template.","type":"array","items":{"examples":[{"name":"Spark Arena","address":"42/80 Mahuhu Crescent, Parnell, Auckland 1010, New Zealand","latitude":-36.847136000000006,"longitued":174.7769837}],"type":"object","properties":{"address":{"description":"The address of the location where the event is held.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.locations.items.[INDEX].address","typeLabel":"string"},"latitude":{"description":"The latitude of the location.","type":"number","isRequired":true,"uniqueKey":"oneOf.0.locations.items.[INDEX].latitude","typeLabel":"number"},"longitude":{"description":"The longitude of the location.","type":"number","isRequired":true,"uniqueKey":"oneOf.0.locations.items.[INDEX].longitude","typeLabel":"number"},"name":{"description":"The name of the location where the event is held.","type":"string","uniqueKey":"oneOf.0.locations.items.[INDEX].name","typeLabel":"string"},"relevantText":{"description":"Text shown in the Apple Wallet notification when the device enters this location. Falls back to name, then address, if not set. Not used by Google Wallet, which has no per-location text.","type":"string","uniqueKey":"oneOf.0.locations.items.[INDEX].relevantText","typeLabel":"string"}},"required":["address","latitude","longitude"],"uniqueKey":"oneOf.0.locations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.locations","typeLabel":"object[]"},"barcodeFormat":{"oneOf":[{"type":"string","description":"The barcode format used to encode the pass code. Supported by both Apple Wallet and Google Wallet. Defaults to QR when unset.","enum":["QR"],"uniqueKey":"oneOf.0.barcodeFormat.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The barcode format used to encode the pass code. Supported by both Apple Wallet and Google Wallet. Defaults to QR when unset.","enum":["PDF417"],"uniqueKey":"oneOf.0.barcodeFormat.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The barcode format used to encode the pass code. Supported by both Apple Wallet and Google Wallet. Defaults to QR when unset.","enum":["Aztec"],"uniqueKey":"oneOf.0.barcodeFormat.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The barcode format used to encode the pass code. Supported by both Apple Wallet and Google Wallet. Defaults to QR when unset.","enum":["Code128"],"uniqueKey":"oneOf.0.barcodeFormat.oneOf.3","typeLabel":"enum\u003cstring>"}],"uniqueKey":"oneOf.0.barcodeFormat","typeLabel":"enum\u003cstring>"},"hideCodeText":{"description":"Hide the human-readable pass code shown beneath the barcode in Apple and Google Wallet. The barcode itself is unaffected.","type":"boolean","uniqueKey":"oneOf.0.hideCodeText","typeLabel":"boolean"},"type":{"type":"string","enum":["offer"],"uniqueKey":"oneOf.0.type","typeLabel":"enum\u003cstring>"},"fields":{"maxItems":4,"type":"array","items":{"description":"A field that is displayed in a voucher, that is identified by the key. It can be defined in a template and overwritten in a pass","examples":[{"key":"voucher","label":"free drinks","value":"1"}],"type":"object","properties":{"key":{"description":"The identifier of the field. This is not presented to the user.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.fields.items.[INDEX].key","typeLabel":"string"},"label":{"description":"The label to go with the value.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.fields.items.[INDEX].label","typeLabel":"string"},"value":{"description":"The data to display.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.fields.items.[INDEX].value","typeLabel":"string"}},"required":["key","label","value"],"uniqueKey":"oneOf.0.fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.fields","typeLabel":"object[]"},"backFields":{"description":"The values can be text, numbers or urls.","type":"array","items":{"description":"A field that is displayed in a voucher, that is identified by the key. It can be defined in a template and overwritten in a pass","examples":[{"key":"voucher","label":"free drinks","value":"1"}],"type":"object","properties":{"key":{"description":"The identifier of the field. This is not presented to the user.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.backFields.items.[INDEX].key","typeLabel":"string"},"label":{"description":"The label to go with the value.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.backFields.items.[INDEX].label","typeLabel":"string"},"value":{"description":"The data to display.","type":"string","isRequired":true,"uniqueKey":"oneOf.0.backFields.items.[INDEX].value","typeLabel":"string"}},"required":["key","label","value"],"uniqueKey":"oneOf.0.backFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.backFields","typeLabel":"object[]"},"archived":{"description":"When true, the template is archived. No new passes can be created and all existing passes are voided.","type":"boolean","uniqueKey":"oneOf.0.archived","typeLabel":"boolean"}},"uniqueKey":"oneOf.0","typeLabel":"Template · object"},{"type":"object","required":["foregroundColor","backgroundColor","icon","logo","banner","title","issuerName","type","startDate","id","accountId"],"properties":{"foregroundColor":{"pattern":"^(#([a-fA-F0-9]{3}){1,2}|(rgb|rgba)(s*(d+%?s*,s*){2,3}(d+%?s*,?s*)d*.?d*s*))$","description":"(Apple and Web Only) A hex or rgb value providing the foreground color. This is used for font color","type":"string","isRequired":true,"uniqueKey":"oneOf.1.foregroundColor","typeLabel":"string"},"backgroundColor":{"pattern":"^(#([a-fA-F0-9]{3}){1,2}|(rgb|rgba)(s*(d+%?s*,s*){2,3}(d+%?s*,?s*)d*.?d*s*))$","description":"A hex or rgb value providing the foreground color","type":"string","isRequired":true,"uniqueKey":"oneOf.1.backgroundColor","typeLabel":"string"},"icon":{"description":"A url to an image of size X by Y.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.icon","typeLabel":"string"},"logo":{"description":"The icon but with text and doesnt need to be square","type":"string","isRequired":true,"uniqueKey":"oneOf.1.logo","typeLabel":"string"},"banner":{"description":"(Google, Apple Only) A url to an image of size X by Y. Also used in link previews.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.banner","typeLabel":"string"},"title":{"description":"The title displayed on the pass.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.title","typeLabel":"string"},"issuerName":{"description":"The name of the issuer.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.1.issuerName","typeLabel":"string"},"type":{"type":"string","enum":["event"],"isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"enum\u003cstring>"},"startDate":{"description":"The UTC date at which the event starts.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.startDate","typeLabel":"string"},"id":{"description":"Id is a unique identifier for the template","type":"string","isRequired":true,"uniqueKey":"oneOf.1.id","typeLabel":"string"},"accountId":{"description":"Account Id is the account the template belongs to","type":"string","isRequired":true,"uniqueKey":"oneOf.1.accountId","typeLabel":"string"},"labelColor":{"pattern":"^(#([a-fA-F0-9]{3}){1,2}|(rgb|rgba)(s*(d+%?s*,s*){2,3}(d+%?s*,?s*)d*.?d*s*))$","description":"(Apple Only) A hex or rgb value providing the label color. If unset then the foreground color is used.","type":"string","uniqueKey":"oneOf.1.labelColor","typeLabel":"string"},"background":{"description":"(Web Only) A url to an image that is displayed as the background. If this is not provided then backgroundColor is used.","type":"string","uniqueKey":"oneOf.1.background","typeLabel":"string"},"sharingProhibited":{"description":"Disable sharing from mobile wallets","type":"boolean","uniqueKey":"oneOf.1.sharingProhibited","typeLabel":"boolean"},"locations":{"maxItems":10,"description":"Locations that trigger lock-screen relevance in Apple and Google Wallet (Apple's locations, Google's merchantLocations). Combined with any pass-level locations when passes are issued from this template.","type":"array","items":{"examples":[{"name":"Spark Arena","address":"42/80 Mahuhu Crescent, Parnell, Auckland 1010, New Zealand","latitude":-36.847136000000006,"longitued":174.7769837}],"type":"object","properties":{"address":{"description":"The address of the location where the event is held.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.locations.items.[INDEX].address","typeLabel":"string"},"latitude":{"description":"The latitude of the location.","type":"number","isRequired":true,"uniqueKey":"oneOf.1.locations.items.[INDEX].latitude","typeLabel":"number"},"longitude":{"description":"The longitude of the location.","type":"number","isRequired":true,"uniqueKey":"oneOf.1.locations.items.[INDEX].longitude","typeLabel":"number"},"name":{"description":"The name of the location where the event is held.","type":"string","uniqueKey":"oneOf.1.locations.items.[INDEX].name","typeLabel":"string"},"relevantText":{"description":"Text shown in the Apple Wallet notification when the device enters this location. Falls back to name, then address, if not set. Not used by Google Wallet, which has no per-location text.","type":"string","uniqueKey":"oneOf.1.locations.items.[INDEX].relevantText","typeLabel":"string"}},"required":["address","latitude","longitude"],"uniqueKey":"oneOf.1.locations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.locations","typeLabel":"object[]"},"barcodeFormat":{"oneOf":[{"type":"string","description":"The barcode format used to encode the pass code. Supported by both Apple Wallet and Google Wallet. Defaults to QR when unset.","enum":["QR"],"uniqueKey":"oneOf.1.barcodeFormat.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The barcode format used to encode the pass code. Supported by both Apple Wallet and Google Wallet. Defaults to QR when unset.","enum":["PDF417"],"uniqueKey":"oneOf.1.barcodeFormat.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The barcode format used to encode the pass code. Supported by both Apple Wallet and Google Wallet. Defaults to QR when unset.","enum":["Aztec"],"uniqueKey":"oneOf.1.barcodeFormat.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The barcode format used to encode the pass code. Supported by both Apple Wallet and Google Wallet. Defaults to QR when unset.","enum":["Code128"],"uniqueKey":"oneOf.1.barcodeFormat.oneOf.3","typeLabel":"enum\u003cstring>"}],"uniqueKey":"oneOf.1.barcodeFormat","typeLabel":"enum\u003cstring>"},"hideCodeText":{"description":"Hide the human-readable pass code shown beneath the barcode in Apple and Google Wallet. The barcode itself is unaffected.","type":"boolean","uniqueKey":"oneOf.1.hideCodeText","typeLabel":"boolean"},"location":{"examples":[{"name":"Spark Arena","address":"42/80 Mahuhu Crescent, Parnell, Auckland 1010, New Zealand","latitude":-36.847136000000006,"longitued":174.7769837}],"type":"object","properties":{"address":{"description":"The address of the location where the event is held.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.location.address","typeLabel":"string"},"latitude":{"description":"The latitude of the location.","type":"number","isRequired":true,"uniqueKey":"oneOf.1.location.latitude","typeLabel":"number"},"longitude":{"description":"The longitude of the location.","type":"number","isRequired":true,"uniqueKey":"oneOf.1.location.longitude","typeLabel":"number"},"name":{"description":"The name of the location where the event is held.","type":"string","uniqueKey":"oneOf.1.location.name","typeLabel":"string"},"relevantText":{"description":"Text shown in the Apple Wallet notification when the device enters this location. Falls back to name, then address, if not set. Not used by Google Wallet, which has no per-location text.","type":"string","uniqueKey":"oneOf.1.location.relevantText","typeLabel":"string"}},"required":["address","latitude","longitude"],"uniqueKey":"oneOf.1.location","typeLabel":"object"},"fields":{"maxItems":4,"type":"array","items":{"description":"A field that is displayed in a voucher, that is identified by the key. It can be defined in a template and overwritten in a pass","examples":[{"key":"voucher","label":"free drinks","value":"1"}],"type":"object","properties":{"key":{"description":"The identifier of the field. This is not presented to the user.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.fields.items.[INDEX].key","typeLabel":"string"},"label":{"description":"The label to go with the value.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.fields.items.[INDEX].label","typeLabel":"string"},"value":{"description":"The data to display.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.fields.items.[INDEX].value","typeLabel":"string"}},"required":["key","label","value"],"uniqueKey":"oneOf.1.fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.fields","typeLabel":"object[]"},"backFields":{"description":"The values can be text, numbers or urls.","type":"array","items":{"description":"A field that is displayed in a voucher, that is identified by the key. It can be defined in a template and overwritten in a pass","examples":[{"key":"voucher","label":"free drinks","value":"1"}],"type":"object","properties":{"key":{"description":"The identifier of the field. This is not presented to the user.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.backFields.items.[INDEX].key","typeLabel":"string"},"label":{"description":"The label to go with the value.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.backFields.items.[INDEX].label","typeLabel":"string"},"value":{"description":"The data to display.","type":"string","isRequired":true,"uniqueKey":"oneOf.1.backFields.items.[INDEX].value","typeLabel":"string"}},"required":["key","label","value"],"uniqueKey":"oneOf.1.backFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.backFields","typeLabel":"object[]"},"archived":{"description":"When true, the template is archived. No new passes can be created and all existing passes are voided.","type":"boolean","uniqueKey":"oneOf.1.archived","typeLabel":"boolean"}},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","required":["foregroundColor","backgroundColor","icon","logo","banner","title","issuerName","type","primaryLabel","thumbnail","id","accountId"],"properties":{"foregroundColor":{"pattern":"^(#([a-fA-F0-9]{3}){1,2}|(rgb|rgba)(s*(d+%?s*,s*){2,3}(d+%?s*,?s*)d*.?d*s*))$","description":"(Apple and Web Only) A hex or rgb value providing the foreground color. This is used for font color","type":"string","isRequired":true,"uniqueKey":"oneOf.2.foregroundColor","typeLabel":"string"},"backgroundColor":{"pattern":"^(#([a-fA-F0-9]{3}){1,2}|(rgb|rgba)(s*(d+%?s*,s*){2,3}(d+%?s*,?s*)d*.?d*s*))$","description":"A hex or rgb value providing the foreground color","type":"string","isRequired":true,"uniqueKey":"oneOf.2.backgroundColor","typeLabel":"string"},"icon":{"description":"A url to an image of size X by Y.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.icon","typeLabel":"string"},"logo":{"description":"The icon but with text and doesnt need to be square","type":"string","isRequired":true,"uniqueKey":"oneOf.2.logo","typeLabel":"string"},"banner":{"description":"(Google, Apple Only) A url to an image of size X by Y. Also used in link previews.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.banner","typeLabel":"string"},"title":{"description":"The title displayed on the pass.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.title","typeLabel":"string"},"issuerName":{"description":"The name of the issuer.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.issuerName","typeLabel":"string"},"type":{"type":"string","enum":["generic"],"isRequired":true,"uniqueKey":"oneOf.2.type","typeLabel":"enum\u003cstring>"},"primaryLabel":{"description":"The label that goes with the primary value of a pass","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.2.primaryLabel","typeLabel":"string"},"thumbnail":{"description":"(Apple Only) An image along side the primary field. This is displayed instead of a banner in Apple Wallet.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.thumbnail","typeLabel":"string"},"id":{"description":"Id is a unique identifier for the template","type":"string","isRequired":true,"uniqueKey":"oneOf.2.id","typeLabel":"string"},"accountId":{"description":"Account Id is the account the template belongs to","type":"string","isRequired":true,"uniqueKey":"oneOf.2.accountId","typeLabel":"string"},"labelColor":{"pattern":"^(#([a-fA-F0-9]{3}){1,2}|(rgb|rgba)(s*(d+%?s*,s*){2,3}(d+%?s*,?s*)d*.?d*s*))$","description":"(Apple Only) A hex or rgb value providing the label color. If unset then the foreground color is used.","type":"string","uniqueKey":"oneOf.2.labelColor","typeLabel":"string"},"background":{"description":"(Web Only) A url to an image that is displayed as the background. If this is not provided then backgroundColor is used.","type":"string","uniqueKey":"oneOf.2.background","typeLabel":"string"},"sharingProhibited":{"description":"Disable sharing from mobile wallets","type":"boolean","uniqueKey":"oneOf.2.sharingProhibited","typeLabel":"boolean"},"locations":{"maxItems":10,"description":"Locations that trigger lock-screen relevance in Apple and Google Wallet (Apple's locations, Google's merchantLocations). Combined with any pass-level locations when passes are issued from this template.","type":"array","items":{"examples":[{"name":"Spark Arena","address":"42/80 Mahuhu Crescent, Parnell, Auckland 1010, New Zealand","latitude":-36.847136000000006,"longitued":174.7769837}],"type":"object","properties":{"address":{"description":"The address of the location where the event is held.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.locations.items.[INDEX].address","typeLabel":"string"},"latitude":{"description":"The latitude of the location.","type":"number","isRequired":true,"uniqueKey":"oneOf.2.locations.items.[INDEX].latitude","typeLabel":"number"},"longitude":{"description":"The longitude of the location.","type":"number","isRequired":true,"uniqueKey":"oneOf.2.locations.items.[INDEX].longitude","typeLabel":"number"},"name":{"description":"The name of the location where the event is held.","type":"string","uniqueKey":"oneOf.2.locations.items.[INDEX].name","typeLabel":"string"},"relevantText":{"description":"Text shown in the Apple Wallet notification when the device enters this location. Falls back to name, then address, if not set. Not used by Google Wallet, which has no per-location text.","type":"string","uniqueKey":"oneOf.2.locations.items.[INDEX].relevantText","typeLabel":"string"}},"required":["address","latitude","longitude"],"uniqueKey":"oneOf.2.locations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.locations","typeLabel":"object[]"},"barcodeFormat":{"oneOf":[{"type":"string","description":"The barcode format used to encode the pass code. Supported by both Apple Wallet and Google Wallet. Defaults to QR when unset.","enum":["QR"],"uniqueKey":"oneOf.2.barcodeFormat.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The barcode format used to encode the pass code. Supported by both Apple Wallet and Google Wallet. Defaults to QR when unset.","enum":["PDF417"],"uniqueKey":"oneOf.2.barcodeFormat.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The barcode format used to encode the pass code. Supported by both Apple Wallet and Google Wallet. Defaults to QR when unset.","enum":["Aztec"],"uniqueKey":"oneOf.2.barcodeFormat.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The barcode format used to encode the pass code. Supported by both Apple Wallet and Google Wallet. Defaults to QR when unset.","enum":["Code128"],"uniqueKey":"oneOf.2.barcodeFormat.oneOf.3","typeLabel":"enum\u003cstring>"}],"uniqueKey":"oneOf.2.barcodeFormat","typeLabel":"enum\u003cstring>"},"hideCodeText":{"description":"Hide the human-readable pass code shown beneath the barcode in Apple and Google Wallet. The barcode itself is unaffected.","type":"boolean","uniqueKey":"oneOf.2.hideCodeText","typeLabel":"boolean"},"fields":{"maxItems":4,"type":"array","items":{"description":"A field that is displayed in a voucher, that is identified by the key. It can be defined in a template and overwritten in a pass","examples":[{"key":"voucher","label":"free drinks","value":"1"}],"type":"object","properties":{"key":{"description":"The identifier of the field. This is not presented to the user.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.fields.items.[INDEX].key","typeLabel":"string"},"label":{"description":"The label to go with the value.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.fields.items.[INDEX].label","typeLabel":"string"},"value":{"description":"The data to display.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.fields.items.[INDEX].value","typeLabel":"string"}},"required":["key","label","value"],"uniqueKey":"oneOf.2.fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.fields","typeLabel":"object[]"},"backFields":{"description":"The values can be text, numbers or urls.","type":"array","items":{"description":"A field that is displayed in a voucher, that is identified by the key. It can be defined in a template and overwritten in a pass","examples":[{"key":"voucher","label":"free drinks","value":"1"}],"type":"object","properties":{"key":{"description":"The identifier of the field. This is not presented to the user.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.backFields.items.[INDEX].key","typeLabel":"string"},"label":{"description":"The label to go with the value.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.backFields.items.[INDEX].label","typeLabel":"string"},"value":{"description":"The data to display.","type":"string","isRequired":true,"uniqueKey":"oneOf.2.backFields.items.[INDEX].value","typeLabel":"string"}},"required":["key","label","value"],"uniqueKey":"oneOf.2.backFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.2.backFields","typeLabel":"object[]"},"archived":{"description":"When true, the template is archived. No new passes can be created and all existing passes are voided.","type":"boolean","uniqueKey":"oneOf.2.archived","typeLabel":"boolean"}},"uniqueKey":"oneOf.2","typeLabel":"object"},{"type":"object","required":["foregroundColor","backgroundColor","icon","logo","banner","title","issuerName","type","primaryLabel","id","accountId"],"properties":{"foregroundColor":{"pattern":"^(#([a-fA-F0-9]{3}){1,2}|(rgb|rgba)(s*(d+%?s*,s*){2,3}(d+%?s*,?s*)d*.?d*s*))$","description":"(Apple and Web Only) A hex or rgb value providing the foreground color. This is used for font color","type":"string","isRequired":true,"uniqueKey":"oneOf.3.foregroundColor","typeLabel":"string"},"backgroundColor":{"pattern":"^(#([a-fA-F0-9]{3}){1,2}|(rgb|rgba)(s*(d+%?s*,s*){2,3}(d+%?s*,?s*)d*.?d*s*))$","description":"A hex or rgb value providing the foreground color","type":"string","isRequired":true,"uniqueKey":"oneOf.3.backgroundColor","typeLabel":"string"},"icon":{"description":"A url to an image of size X by Y.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.icon","typeLabel":"string"},"logo":{"description":"The icon but with text and doesnt need to be square","type":"string","isRequired":true,"uniqueKey":"oneOf.3.logo","typeLabel":"string"},"banner":{"description":"(Google, Apple Only) A url to an image of size X by Y. Also used in link previews.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.banner","typeLabel":"string"},"title":{"description":"The title displayed on the pass.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.3.title","typeLabel":"string"},"issuerName":{"description":"The name of the issuer.","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.3.issuerName","typeLabel":"string"},"type":{"type":"string","enum":["membership"],"isRequired":true,"uniqueKey":"oneOf.3.type","typeLabel":"enum\u003cstring>"},"primaryLabel":{"description":"The label that goes with the primary value of a pass","minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.3.primaryLabel","typeLabel":"string"},"id":{"description":"Id is a unique identifier for the template","type":"string","isRequired":true,"uniqueKey":"oneOf.3.id","typeLabel":"string"},"accountId":{"description":"Account Id is the account the template belongs to","type":"string","isRequired":true,"uniqueKey":"oneOf.3.accountId","typeLabel":"string"},"labelColor":{"pattern":"^(#([a-fA-F0-9]{3}){1,2}|(rgb|rgba)(s*(d+%?s*,s*){2,3}(d+%?s*,?s*)d*.?d*s*))$","description":"(Apple Only) A hex or rgb value providing the label color. If unset then the foreground color is used.","type":"string","uniqueKey":"oneOf.3.labelColor","typeLabel":"string"},"background":{"description":"(Web Only) A url to an image that is displayed as the background. If this is not provided then backgroundColor is used.","type":"string","uniqueKey":"oneOf.3.background","typeLabel":"string"},"sharingProhibited":{"description":"Disable sharing from mobile wallets","type":"boolean","uniqueKey":"oneOf.3.sharingProhibited","typeLabel":"boolean"},"locations":{"maxItems":10,"description":"Locations that trigger lock-screen relevance in Apple and Google Wallet (Apple's locations, Google's merchantLocations). Combined with any pass-level locations when passes are issued from this template.","type":"array","items":{"examples":[{"name":"Spark Arena","address":"42/80 Mahuhu Crescent, Parnell, Auckland 1010, New Zealand","latitude":-36.847136000000006,"longitued":174.7769837}],"type":"object","properties":{"address":{"description":"The address of the location where the event is held.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.locations.items.[INDEX].address","typeLabel":"string"},"latitude":{"description":"The latitude of the location.","type":"number","isRequired":true,"uniqueKey":"oneOf.3.locations.items.[INDEX].latitude","typeLabel":"number"},"longitude":{"description":"The longitude of the location.","type":"number","isRequired":true,"uniqueKey":"oneOf.3.locations.items.[INDEX].longitude","typeLabel":"number"},"name":{"description":"The name of the location where the event is held.","type":"string","uniqueKey":"oneOf.3.locations.items.[INDEX].name","typeLabel":"string"},"relevantText":{"description":"Text shown in the Apple Wallet notification when the device enters this location. Falls back to name, then address, if not set. Not used by Google Wallet, which has no per-location text.","type":"string","uniqueKey":"oneOf.3.locations.items.[INDEX].relevantText","typeLabel":"string"}},"required":["address","latitude","longitude"],"uniqueKey":"oneOf.3.locations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.locations","typeLabel":"object[]"},"barcodeFormat":{"oneOf":[{"type":"string","description":"The barcode format used to encode the pass code. Supported by both Apple Wallet and Google Wallet. Defaults to QR when unset.","enum":["QR"],"uniqueKey":"oneOf.3.barcodeFormat.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The barcode format used to encode the pass code. Supported by both Apple Wallet and Google Wallet. Defaults to QR when unset.","enum":["PDF417"],"uniqueKey":"oneOf.3.barcodeFormat.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The barcode format used to encode the pass code. Supported by both Apple Wallet and Google Wallet. Defaults to QR when unset.","enum":["Aztec"],"uniqueKey":"oneOf.3.barcodeFormat.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The barcode format used to encode the pass code. Supported by both Apple Wallet and Google Wallet. Defaults to QR when unset.","enum":["Code128"],"uniqueKey":"oneOf.3.barcodeFormat.oneOf.3","typeLabel":"enum\u003cstring>"}],"uniqueKey":"oneOf.3.barcodeFormat","typeLabel":"enum\u003cstring>"},"hideCodeText":{"description":"Hide the human-readable pass code shown beneath the barcode in Apple and Google Wallet. The barcode itself is unaffected.","type":"boolean","uniqueKey":"oneOf.3.hideCodeText","typeLabel":"boolean"},"fields":{"maxItems":4,"type":"array","items":{"description":"A field that is displayed in a voucher, that is identified by the key. It can be defined in a template and overwritten in a pass","examples":[{"key":"voucher","label":"free drinks","value":"1"}],"type":"object","properties":{"key":{"description":"The identifier of the field. This is not presented to the user.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.fields.items.[INDEX].key","typeLabel":"string"},"label":{"description":"The label to go with the value.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.fields.items.[INDEX].label","typeLabel":"string"},"value":{"description":"The data to display.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.fields.items.[INDEX].value","typeLabel":"string"}},"required":["key","label","value"],"uniqueKey":"oneOf.3.fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.fields","typeLabel":"object[]"},"backFields":{"description":"The values can be text, numbers or urls.","type":"array","items":{"description":"A field that is displayed in a voucher, that is identified by the key. It can be defined in a template and overwritten in a pass","examples":[{"key":"voucher","label":"free drinks","value":"1"}],"type":"object","properties":{"key":{"description":"The identifier of the field. This is not presented to the user.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.backFields.items.[INDEX].key","typeLabel":"string"},"label":{"description":"The label to go with the value.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.backFields.items.[INDEX].label","typeLabel":"string"},"value":{"description":"The data to display.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.backFields.items.[INDEX].value","typeLabel":"string"}},"required":["key","label","value"],"uniqueKey":"oneOf.3.backFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.3.backFields","typeLabel":"object[]"},"archived":{"description":"When true, the template is archived. No new passes can be created and all existing passes are voided.","type":"boolean","uniqueKey":"oneOf.3.archived","typeLabel":"boolean"}},"uniqueKey":"oneOf.3","typeLabel":"object"}],"uniqueKey":"","typeLabel":"Template · object · object · object · object"},"examples":{"Example":{"title":"Example","value":{"id":"drink_voucher","accountId":"LDvGjp645u6Q6t9pbvog","foregroundColor":"#FFFFF","backgroundColor":"#043A80","logo":"https://myshout.co/images/logo-white.svg","background":"https://myshout.co/images/backgrounds/image-62.jpg","icon":"https://myshout.co/images/favicon-150.png","title":"My Shout Drink Voucher","issuerName":"My Shout","sharingProhibited":false,"fields":[{"key":"voucher","label":"free drinks","value":"1"}],"backFields":[{"key":"terms","label":"Terms and Condictions","value":"https://myshout.co/terms"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"1080d5e3-9313-42f7-b938-6c406fe9ce2f":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","uniqueKey":"statusCode","typeLabel":"number"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"title":"HttpError","uniqueKey":"","typeLabel":"HttpError · object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"code":"\u003cstring>","error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b6f86eb5-296c-4c44-b0d3-825a898fa3bf":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","uniqueKey":"statusCode","typeLabel":"number"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"title":"HttpError","uniqueKey":"","typeLabel":"HttpError · object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"code":"\u003cstring>","error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"41c92773-f81b-430c-885a-279d49a14f69":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"3488112f-d7e8-496d-b720-fee63c0f4059":{"url":"https://api.passform.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"passform","siteName":"Passform Docs","title":"Get template - Passform Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-07T22:26:06.596Z","originalFileLocation":"api-reference/templates/get-template.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Gets the template for creating passes from the given id\">\u003cmeta data-mint-head name=\"application-name\" content=\"Passform Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get template - Passform Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Gets the template for creating passes from the given id\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Passform Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.passform.io/api-reference/templates/get-template\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://passform.mintlify.app/_mintlify/api/og/v2?division=templates\u0026amp;title=Get+template\u0026amp;description=Gets+the+template+for+creating+passes+from+the+given+id\u0026amp;theme=6de1795354b2e2a3f6ca671d\u0026amp;signature=cd3532b672fab6f4ab4a7e11f6794d83082a1f735ea905a89187db66c609f7f0\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get template - Passform Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Gets the template for creating passes from the given id\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://passform.mintlify.app/_mintlify/api/og/v2?division=templates\u0026amp;title=Get+template\u0026amp;description=Gets+the+template+for+creating+passes+from+the+given+id\u0026amp;theme=6de1795354b2e2a3f6ca671d\u0026amp;signature=cd3532b672fab6f4ab4a7e11f6794d83082a1f735ea905a89187db66c609f7f0\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/passform/dcIVTjFp3kP0357g/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Passform Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#009485\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.passform.io/api-reference/templates/get-template\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/templates/get-template.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.passform.io/#organization\",\"name\":\"Passform Docs\",\"url\":\"https://docs.passform.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/passform/pcWZEUYGXmyjRGIQ/logo/logo-black.png?fit=max\u0026auto=format\u0026n=pcWZEUYGXmyjRGIQ\u0026q=85\u0026s=246ff0edaaabc72a37df70791750c3f5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.passform.io#website\",\"name\":\"Passform Docs\",\"url\":\"https://docs.passform.io\",\"publisher\":{\"@id\":\"https://docs.passform.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.passform.io/api-reference/templates/get-template#webpage\",\"url\":\"https://docs.passform.io/api-reference/templates/get-template\",\"name\":\"Get template\",\"description\":\"Gets the template for creating passes from the given id\",\"dateModified\":\"2026-10-07T22:26:06.596Z\",\"isPartOf\":{\"@id\":\"https://docs.passform.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.passform.io/api-reference/templates/get-template#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.passform.io/api-reference/templates/get-template#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.passform.io/api-reference/api-welcome-message\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"templates\",\"item\":\"https://docs.passform.io/api-reference/templates/list-templates\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get template\",\"item\":\"https://docs.passform.io/api-reference/templates/get-template\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.passform.io/api-reference/templates/get-template#apireference\",\"headline\":\"Get template\",\"name\":\"Get template\",\"description\":\"Gets the template for creating passes from the given id\",\"url\":\"https://docs.passform.io/api-reference/templates/get-template\",\"mainEntityOfPage\":{\"@id\":\"https://docs.passform.io/api-reference/templates/get-template#webpage\"},\"dateModified\":\"2026-10-07T22:26:06.596Z\",\"publisher\":{\"@id\":\"https://docs.passform.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.passform.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Passform Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Passform Docs","nav":{"global":{"anchors":[{"anchor":"Support","icon":"envelope","href":"mailto:support@passform.io"},{"anchor":"LinkedIn","icon":"linkedin","href":"https://linkedin.com/company/passform-io"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"API Reference","pages":[{"title":"API welcome message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /","href":"/api-reference/api-welcome-message"}]},{"group":"accounts","pages":[{"title":"Get account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/account","href":"/api-reference/accounts/get-account"},{"title":"Invite account member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/account/invite","href":"/api-reference/accounts/invite-account-member"},{"title":"Accept account invite","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/account/accept","href":"/api-reference/accounts/accept-account-invite"}]},{"group":"memberships","pages":[{"title":"Get membership member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/memberships/members/{memberId}","href":"/api-reference/memberships/get-membership-member"}]},{"group":"passes","pages":[{"title":"Get pass Google Wallet URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pass/{accountId}/{templateId}/{passId}/google","href":"/api-reference/passes/get-pass-google-wallet-url"},{"title":"Get pass Apple Wallet file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pass/{accountId}/{templateId}/{passId}/apple","href":"/api-reference/passes/get-pass-apple-wallet-file"},{"title":"Get Apple Wallet bundle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pass/{accountId}/bundle/apple","href":"/api-reference/passes/get-apple-wallet-bundle"},{"title":"Get Google Wallet bundle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pass/{accountId}/bundle/google","href":"/api-reference/passes/get-google-wallet-bundle"},{"title":"Create pass","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/pass/{templateId}","href":"/api-reference/passes/create-pass"},{"title":"List passes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pass/{templateId}/passes","href":"/api-reference/passes/list-passes"},{"title":"Get pass","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/pass/{templateId}/{passId}","href":"/api-reference/passes/get-pass"},{"title":"Upsert pass","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/pass/{templateId}/{passId}","href":"/api-reference/passes/upsert-pass"},{"title":"Notify pass","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/pass/{templateId}/{passId}/notify","href":"/api-reference/passes/notify-pass"},{"title":"Update pass metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/pass/{templateId}/{passId}/metadata","href":"/api-reference/passes/update-pass-metadata"},{"title":"Move pass to another template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/pass/{templateId}/{passId}/move","href":"/api-reference/passes/move-pass-to-another-template"}]},{"group":"templates","pages":[{"title":"List templates","description":"Get a list of template Ids","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates","href":"/api-reference/templates/list-templates"},{"title":"Get template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{templateId}","href":"/api-reference/templates/get-template"},{"title":"Upsert template","description":"Upsert a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates/{templateId}","href":"/api-reference/templates/upsert-template"},{"title":"Archive template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates/{templateId}/archive","href":"/api-reference/templates/archive-template"},{"title":"Upload template images","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates/{templateId}/images","href":"/api-reference/templates/upload-template-images"},{"title":"List templates (paged)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/list","href":"/api-reference/templates/list-templates-paged"}]},{"group":"user","pages":[{"title":"Update user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/user","href":"/api-reference/user/update-user"}]}]}]}]},"basePath":"","title":"Get template - Passform Docs","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}