Get a template

Beta

GET

/v2/templates/:uuid

GET

/api/v2/templates/:uuid

curl https://api-sandbox.payabli.com/api/v2/templates/019ff129-d393-7761-9a31-e5afe85b4081 \
     -H "Authorization: Bearer <token>"

{
  "uuid": "019ff129-d393-7761-9a31-e5afe85b4081",
  "orgId": 123,
  "orgName": "PropertyManager Pro",
  "name": "Standard boarding template",
  "description": null,
  "slug": null,
  "status": "active",
  "currentVersionUuid": "019ff129-d396-74c4-86da-ae3d082d7ef9",
  "currentVersion": {
    "uuid": "019ff129-d396-74c4-86da-ae3d082d7ef9",
    "version": 1,
    "services": {
      "ach": "merchantDecision",
      "card": "preSelected",
      "checkRdc": "merchantDecision"
    },
    "fieldConfigurations": [
      {
        "attributes": [
          "required",
          "visible"
        ],
        "defaultValue": null,
        "fieldPath": "business.website",
        "hint": null,
        "label": "Website"
      },
      {
        "attributes": [
          "required",
          "visible"
        ],
        "custom": true,
        "defaultValue": null,
        "fieldPath": "business.salesChannel",
        "hint": null,
        "label": "Sales Channel",
        "options": [
          "In-Store",
          "Online",
          "Both"
        ],
        "questionType": "multipleChoiceSingle"
      },
      {
        "attributes": [
          "required",
          "visible"
        ],
        "custom": true,
        "defaultValue": null,
        "fieldPath": "business.customerType",
        "hint": null,
        "label": "Primary Customer Type",
        "options": [
          "B2B",
          "B2C",
          "Both"
        ],
        "questionType": "multipleChoiceSingle"
      },
      {
        "attributes": [
          "required",
          "visible"
        ],
        "custom": true,
        "defaultValue": null,
        "fieldPath": "business.yearsInBusiness",
        "hint": null,
        "label": "Years in Business",
        "options": [
          "Less than 1",
          "1-3",
          "3-5",
          "5-10",
          "10+"
        ],
        "questionType": "dropdown"
      },
      {
        "attributes": [
          "visible"
        ],
        "custom": true,
        "defaultValue": null,
        "fieldPath": "business.refundPolicy",
        "hint": null,
        "label": "Describe your refund policy",
        "options": null,
        "questionType": "textarea"
      }
    ],
    "conditionalRules": [
      {
        "actions": [
          {
            "actionType": "setFieldAttributes",
            "fieldPath": "business.website",
            "readOnly": null,
            "required": true,
            "visible": null
          }
        ],
        "conditions": [
          {
            "fieldPath": "business.salesChannel",
            "operator": "equals",
            "value": "Online"
          }
        ],
        "description": "Require the website field when sales happen online.",
        "enabled": true,
        "matchMode": "all",
        "ruleName": "require-website-online"
      },
      {
        "actions": [
          {
            "actionType": "setFieldAttributes",
            "fieldPath": "business.refundPolicy",
            "readOnly": null,
            "required": true,
            "visible": true
          }
        ],
        "conditions": [
          {
            "fieldPath": "business.merchantCatCode",
            "operator": "equals",
            "value": "3000"
          }
        ],
        "description": "Require the refund policy field when the merchant category code (MCC) is 3000 (airlines).",
        "enabled": true,
        "matchMode": "all",
        "ruleName": "require-refund-policy-airlines"
      }
    ],
    "documents": [
      {
        "allowedFormats": [
          "pdf",
          "jpg",
          "png"
        ],
        "attributes": [
          "required",
          "visible"
        ],
        "fieldPath": "documents.bankStatement",
        "hint": "3 most recent months",
        "label": "Bank Statement",
        "maxUploads": 3,
        "preset": true
      }
    ],
    "devices": [
      {
        "deviceId": "ingenico_axium_dx8",
        "preSelected": false
      },
      {
        "deviceId": "ingenico_axium_rx9000",
        "preSelected": false
      }
    ],
    "hiddenSections": [
      "welcome"
    ],
    "allowedMccs": [
      5200,
      8998
    ],
    "underwriting": "automatic",
    "mpaContent": "<p>Merchant Processing Agreement</p>",
    "payinPricingId": 1289,
    "payoutPricingId": null,
    "allowGuidedTour": false,
    "allowBusinessPrefill": true,
    "allowSaveForLater": true,
    "allowMultipleBanks": true,
    "allowServiceSelection": true,
    "allowDeviceSelection": true,
    "allowAmigoChat": true,
    "allowUserCreation": true,
    "allowPeoplePrefill": false,
    "verticalProgress": true,
    "useFloatingInputs": false,
    "centerContent": true,
    "allowRealTimeBankVerification": true,
    "allowCheckboxSigning": true,
    "allowTypedSignature": true,
    "allowWrittenSignature": true,
    "allowMultiOwnerEsign": false,
    "allowConfirmationAndAttestation": true,
    "allowPCIAttestation": false,
    "createdAt": "2026-07-01T15:00:01.038310",
    "createdBy": "0"
  },
  "isInherited": false,
  "readOnly": false,
  "createdBy": "0",
  "updatedBy": "0",
  "createdAt": "2026-07-01T15:00:01.035727",
  "updatedAt": "2026-07-01T15:00:01.040548"
}

Retrieves a boarding template by UUID, including its current content version.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

uuidstringRequired

The template's UUID.

Response

The template.

uuidstringformat: "uuid"

The template's unique identifier, used to read and manage the template.

orgIdinteger

The numeric identifier of the organization that owns the template.

orgNamestring or null

The name of the organization that owns the template.

namestring

The template's display name.

descriptionstring or null

An optional description of the template.

slugstring or null

An optional URL-friendly identifier for the template.

statusenum

The template's lifecycle status.

Allowed values:

currentVersionUuidstringformat: "uuid"

The UUID of the template's active content version.

currentVersionobject

The template's active content version.

isInheritedboolean

Whether the template is inherited from an ancestor organization rather than owned directly.

readOnlyboolean

Whether the template is read-only for the calling organization.

createdBystring

The identifier of the user who created the template.

updatedBystring

The identifier of the user who last updated the template.

createdAtstring

When the template was created.

updatedAtstring

When the template was last updated.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error