> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://beta-docs.payabli.com/api-reference/templates/get-boarding-template-by-id/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server.

# Get template

GET https://api-sandbox.payabli.com/api/Templates/get/{templateId}

Retrieves a boarding template's details by ID. 

Reference: https://beta-docs.payabli.com/api-reference/templates/get-boarding-template-by-id

## Authentication

- `requestToken` header (required) — API Key authentication via header

## Servers

- `https://api-sandbox.payabli.com/api` (Sandbox, default)
- `https://api.payabli.com/api` (Production)

## Request

### Path parameters

- `templateId` (double, required) — The boarding template ID. Can be found at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.

## Response

### 200

Success

- `addPrice` (boolean, optional)
- `boardingLinks` (list of BoardingQueryLinks, optional)
- `createdAt` (datetime, optional) — Timestamp of when record was created, in UTC.
- `idTemplate` (long, optional)
- `isRoot` (boolean, optional) — When `true`, indicates that this is the organization's root template.
- `orgParentName` (string, optional) — The name of the parent organization.
- `recipientEmailNotification` (boolean, optional) — When `true`, Payabli will send the applicant a boarding link. Set this value to `false` if you are sending pre-filled applications via the API and don't want Payabli to send the applicant an email to complete the boarding application.
- `resumable` (boolean, optional) — When `true`, the applicant can save an incomplete application and resume it later. When `false`, the applicant won't have an option to save their progress, and must complete the application in one session.
- `templateCode` (string, optional) — The internal code for the template.
- `templateContent` (TemplateContentResponse, optional)
- `templateDescription` (string, optional)
- `templateTitle` (string, optional)
- `usedBy` (integer, optional)

## Errors

### 400 Bad Request Error

Bad request/ invalid data

- `any`

### 401 Unauthorized Error

Unauthorized request.

- `any`

### 500 Internal Server Error

Internal API Error

- `any`

### 503 Service Unavailable Error

Database connection error

- `isSuccess` (boolean, optional) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure.
- `responseData` (map from string to any, optional) — The object containing the response data.
- `responseText` (string, optional) — Response text for operation: 'Success' or 'Declined'.

## Types

### BoardingQueryLinks

- `acceptOauth` (boolean, optional)
- `acceptRegister` (boolean, optional)
- `entryAttributes` (string, optional)
- `id` (integer, optional) — The boarding link ID. Can be found at the end of the boarding link reference name. The boarding link reference name. For example `https://boarding.payabli.com/boarding/app/myorgaccountname-00091`. The ID is `91`.
- `lastUpdated` (datetime, optional) — Timestamp of when record was last updated, in UTC.
- `orgParentName` (string, optional) — The name of the parent organization.
- `referenceName` (string, optional)
- `referenceTemplateId` (long, optional)
- `templateCode` (string, optional) — The internal code for the template.
- `templateName` (string, optional) — The template name.

### TemplateContentResponse

- `businessData` (BusinessSection, optional) — Details about a business.
- `documentsData` (DocumentSection, optional)
- `ownershipData` (OwnersSection, optional) — Information about a business owner.
- `processingData` (ProcessingSection, optional)
- `salesData` (SalesSection, optional)
- `servicesData` (ServicesSection, optional) — Details about pricing and payment services for a business.
- `underwritingData` (UnderwritingDataResponse, optional) — Underwriting data is used to manage risk orchestration in the boarding application lifecycle.

### BusinessSection

Details about a business.

- `baddress` (TemplateElement, optional)
- `baddress1` (TemplateElement, optional)
- `bcity` (TemplateElement, optional)
- `bcountry` (TemplateElement, optional)
- `bstate` (TemplateElement, optional)
- `btype` (TemplateElement, optional)
- `bzip` (TemplateElement, optional)
- `dbaname` (TemplateElement, optional)
- `ein` (TemplateElement, optional)
- `faxnumber` (TemplateElement, optional)
- `legalname` (TemplateElement, optional)
- `license` (TemplateElement, optional)
- `licstate` (TemplateElement, optional)
- `maddress` (TemplateElement, optional)
- `maddress1` (TemplateElement, optional)
- `mcity` (TemplateElement, optional)
- `mcountry` (TemplateElement, optional)
- `mstate` (TemplateElement, optional)
- `mzip` (TemplateElement, optional)
- `phonenumber` (TemplateElement, optional)
- `startdate` (TemplateElement, optional)
- `taxfillname` (TemplateElement, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.
- `website` (TemplateElement, optional)

### DocumentSection

- `depositBank` (BankSection, optional) — Details about a bank account.
- `minimumDocuments` (integer, optional) — The minimum number of documents the applicant must upload with the application.
- `subFooter` (string, optional)
- `subHeader` (string, optional)
- `termsAndConditions` (DocumentSectionTermsAndConditions, optional)
- `uploadDocuments` (boolean, optional) — When `true`, allows the applicant to upload documents to the application.
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.
- `withdrawalBank` (BankSection, optional) — Details about a bank account.

### OwnersSection

Information about a business owner.

- `contactEmail` (TemplateElement, optional)
- `contactName` (TemplateElement, optional)
- `contactPhone` (TemplateElement, optional)
- `contactTitle` (TemplateElement, optional)
- `multipleContacts` (boolean, optional) — Offer add more contacts
- `multipleOwners` (boolean, optional) — offer add more owners
- `oaddress` (TemplateElement, optional)
- `ocity` (TemplateElement, optional)
- `ocountry` (TemplateElement, optional)
- `odriverstate` (TemplateElement, optional)
- `ostate` (TemplateElement, optional)
- `ownerdob` (TemplateElement, optional)
- `ownerdriver` (TemplateElement, optional)
- `owneremail` (TemplateElement, optional)
- `ownername` (TemplateElement, optional)
- `ownerpercent` (TemplateElement, optional)
- `ownerphone1` (TemplateElement, optional)
- `ownerphone2` (TemplateElement, optional)
- `ownerssn` (TemplateElement, optional)
- `ownertitle` (TemplateElement, optional)
- `ozip` (TemplateElement, optional)
- `subFooter` (string, optional)
- `subHeader` (string, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### ProcessingSection

- `avgmonthly` (TemplateElement, optional)
- `binperson` (TemplateElement, optional)
- `binphone` (TemplateElement, optional)
- `binweb` (TemplateElement, optional)
- `bsummary` (TemplateElement, optional)
- `highticketamt` (TemplateElement, optional)
- `mcc` (TemplateElement, optional)
- `subFooter` (string, optional)
- `subHeader` (string, optional)
- `ticketamt` (TemplateElement, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.
- `whenCharged` (TemplateElement, optional)
- `whenDelivered` (TemplateElement, optional)
- `whenProvided` (TemplateElement, optional)
- `whenRefunded` (TemplateElement, optional)

### SalesSection

- `salesCode` (string, optional)
- `salesCRM` (string, optional)

### ServicesSection

Details about pricing and payment services for a business.

- `ach` (AchService, optional)
- `card` (CardService, optional)
- `subFooter` (string, optional)
- `subHeader` (string, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### UnderwritingDataResponse

Underwriting data is used to manage risk orchestration in the boarding application lifecycle.

- `method` (enum, optional) — This field controls which method is used to handle risk orchestration. - `automatic`: Sends the application through the automatic underwriting workflow using the provided `policyId`. - `manual`: Puts the application into the pending review status. An analyst must manually change it's final status to approved or declined. - `bypass`: The application won't go through Payabli's review, and proceeds directly to boarding products and services.
  - Allowed values: `automatic`, `manual`, `bypass`
- `policyId` (string, optional) — Used to identify the risk workflow used to review this account. Policy IDs must be created before using automatic underwriting, and is **required** when `method` is `automatic`.

### TemplateElement

- `posCol` (integer, optional) — The element's column position.
- `posRow` (integer, optional) — The element's row position.
- `readOnly` (boolean, optional) — When `true`, the element is read-only.
- `value` (string, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### BankSection

Details about a bank account.

- `accountNumber` (TemplateElement, optional)
- `accountType` (TemplateElement, optional)
- `bankName` (TemplateElement, optional)
- `routingNumber` (TemplateElement, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### DocumentSectionTermsAndConditions

- `tcLinks` (list of DocumentSectionTermsAndConditionsTcLinksItem, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### AchService

- `achAbsorb` (AchAbsorbSection, optional)
- `achAbsorb_highPayRange` (TemplateElement, optional)
- `achAbsorb_lowPayRange` (TemplateElement, optional)
- `achAcceptance` (AchAcceptanceElement, optional)
- `achFees` (AchFeeSection, optional)
- `achPass_highPayRange` (TemplateElement, optional)
- `achPass_lowPayRange` (TemplateElement, optional)
- `achPassThrough` (AchPassThroughSection, optional)
- `batchCutoffTime` (TemplateElement, optional) — Controls how to present the `batchCutoffTime` field on the application. If this field is not sent, batch cut off time defaults to 5 ET.
- `discountFrequency` (TemplateElement, optional)
- `fundingRollup` (TemplateElement, optional)
- `gateway` (TemplateElement, optional)
- `pdfTemplateId` (TemplateElement, optional)
- `pricingPlan` (long, optional)
- `pricingType` (TemplateElement, optional)
- `processor` (TemplateElement, optional)
- `provider` (TemplateElement, optional)
- `tierName` (TemplateElement, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### CardService

- `batchCutoffTime` (TemplateElement, optional) — Controls how to present the `batchCutoffTime` field on the application. If this field is not sent, batch cut off time defaults to 5 ET.
- `cardAcceptance` (CardAcceptanceElement, optional)
- `cardFees` (CardFeeSection, optional)
- `cardFlat` (CardFlatSection, optional)
- `cardFlat_amountxAuth` (TemplateElement, optional)
- `cardFlat_highPayRange` (TemplateElement, optional)
- `cardFlat_lowPayRange` (TemplateElement, optional)
- `cardFlat_percentxAuth` (TemplateElement, optional)
- `cardICP` (CardIcpSection, optional)
- `cardICP_amountxAuth` (TemplateElement, optional)
- `cardICP_highPayRange` (TemplateElement, optional)
- `cardICP_lowPayRange` (TemplateElement, optional)
- `cardICP_percentxAuth` (TemplateElement, optional)
- `cardPassThrough` (CardPassThroughSection, optional)
- `cardPassThrough_amountRecurring` (TemplateElement, optional)
- `cardPassThrough_amountxAuth` (TemplateElement, optional)
- `cardPassThrough_highPayRange` (TemplateElement, optional)
- `cardPassThrough_lowPayRange` (TemplateElement, optional)
- `cardPassThrough_percentRecurring` (TemplateElement, optional)
- `cardPassThrough_percentxAuth` (TemplateElement, optional)
- `discountFrequency` (TemplateElement, optional)
- `fundingRollup` (TemplateElement, optional)
- `gateway` (TemplateElement, optional)
- `passThroughCost` (TemplateElement, optional)
- `pdfTemplateId` (TemplateElement, optional)
- `pricingPlan` (long, optional)
- `pricingType` (TemplateElement, optional)
- `processor` (TemplateElement, optional)
- `provider` (TemplateElement, optional)
- `tierName` (TemplateElement, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### DocumentSectionTermsAndConditionsTcLinksItem

- `label` (string, optional)
- `value` (string, optional)

### AchAbsorbSection

- `multiTier` (boolean, optional)
- `tiers` (list of AchTypesTiers, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### AchAcceptanceElement

- `types` (AchTypes, optional)
- `posCol` (integer, optional) — The element's column position.
- `posRow` (integer, optional) — The element's row position.
- `readOnly` (boolean, optional) — When `true`, the element is read-only.
- `value` (string, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### AchFeeSection

- `advancedSettlementAchFee` (TemplateElement, optional)
- `annualAchFee` (TemplateElement, optional)
- `chargebackAchFee` (TemplateElement, optional)
- `earlyTerminationAchFee` (TemplateElement, optional)
- `monthlyAchFee` (TemplateElement, optional)
- `quarterlyPCIAchFee` (TemplateElement, optional)
- `returnedAchFee` (TemplateElement, optional)
- `sameDayAchFee` (TemplateElement, optional)
- `sundayOriginationAchFee` (TemplateElement, optional)
- `verifyBankAchFee` (TemplateElement, optional)
- `verifyFundAchFee` (TemplateElement, optional)
- `verifyNegativeAchFee` (TemplateElement, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### AchPassThroughSection

- `multiTier` (boolean, optional)
- `tiers` (list of AchTypesPass, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### CardAcceptanceElement

- `types` (CardTypes, optional)
- `posCol` (integer, optional) — The element's column position.
- `posRow` (integer, optional) — The element's row position.
- `readOnly` (boolean, optional) — When `true`, the element is read-only.
- `value` (string, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### CardFeeSection

- `achBatchCardFee` (TemplateElement, optional)
- `annualCardFee` (TemplateElement, optional)
- `avsCardFee` (TemplateElement, optional)
- `chargebackCardFee` (TemplateElement, optional)
- `ddaRejectsCardFee` (TemplateElement, optional)
- `earlyTerminationCardFee` (TemplateElement, optional)
- `minimumProcessingCardFee` (TemplateElement, optional)
- `monthlyPCICardFee` (TemplateElement, optional)
- `montlyPlatformCardFee` (TemplateElement, optional)
- `retrievalCardFee` (TemplateElement, optional)
- `transactionCardFee` (TemplateElement, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### CardFlatSection

- `tiers` (list of CardType, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### CardIcpSection

- `tiers` (list of CardType, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### CardPassThroughSection

- `multiTier` (boolean, optional)
- `tiers` (list of CardTypePass, optional)
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### AchTypesTiers

- `ccd` (TierItem, optional)
- `ppd` (TierItem, optional)
- `web` (TierItem, optional)

### AchTypes

- `ccd` (BasicTemplateElement, optional)
- `ppd` (BasicTemplateElement, optional)
- `web` (BasicTemplateElement, optional)

### AchTypesPass

- `ccd` (TierItemPass, optional)
- `ppd` (TierItemPass, optional)
- `web` (TierItemPass, optional)

### CardTypes

- `amex` (BasicTemplateElement, optional)
- `discover` (BasicTemplateElement, optional)
- `masterCard` (BasicTemplateElement, optional)
- `visa` (BasicTemplateElement, optional)

### CardType

- `amex` (TierItem, optional)
- `discover` (TierItem, optional)
- `masterCard` (TierItem, optional)
- `visa` (TierItem, optional)

### CardTypePass

- `amex` (TierItemPass, optional)
- `discover` (TierItemPass, optional)
- `masterCard` (TierItemPass, optional)
- `visa` (TierItemPass, optional)

### TierItem

- `amountxAuth` (double, optional)
- `highPayRange` (double, optional)
- `lowPayRange` (double, optional)
- `percentxAuth` (double, optional)

### BasicTemplateElement

- `readOnly` (boolean, optional) — When `true`, the element is read-only.
- `required` (boolean, optional) — When `true`, the element is required.
- `visible` (boolean, optional) — When `true`, makes the section visible on the application.

### TierItemPass

- `amountFeeone-time` (double, optional)
- `amountFeeRecurring` (double, optional)
- `highPayRange` (double, optional)
- `lowPayRange` (double, optional)
- `percentFeeone-time` (double, optional)
- `percentFeeRecurring` (double, optional)

## Examples

**Response**

```json
{
  "addPrice": true,
  "boardingLinks": [
    {
      "acceptOauth": false,
      "acceptRegister": false,
      "entryAttributes": "entryAttributes",
      "id": 91,
      "lastUpdated": "2022-07-01T15:00:01Z",
      "orgParentName": "PropertyManager Pro",
      "referenceName": "payabli-00710",
      "referenceTemplateId": 1830,
      "templateCode": "templateCode",
      "templateName": "SMB"
    }
  ],
  "createdAt": "2022-07-01T15:00:01Z",
  "idTemplate": 1000000,
  "isRoot": false,
  "orgParentName": "PropertyManager Pro",
  "recipientEmailNotification": true,
  "resumable": false,
  "templateCode": "templateCode",
  "templateContent": {
    "businessData": {
      "visible": true
    },
    "documentsData": {
      "minimumDocuments": 1,
      "subFooter": "subFooter",
      "subHeader": "subHeader",
      "uploadDocuments": true,
      "visible": true
    },
    "ownershipData": {
      "multipleContacts": true,
      "multipleOwners": true,
      "subFooter": "subFooter",
      "subHeader": "subHeader",
      "visible": true
    },
    "processingData": {
      "subFooter": "subFooter",
      "subHeader": "subHeader",
      "visible": true
    },
    "salesData": {
      "salesCode": "salesCode",
      "salesCRM": "salesCRM"
    },
    "servicesData": {
      "subFooter": "subFooter",
      "subHeader": "subHeader",
      "visible": true
    },
    "underwritingData": {
      "method": "automatic",
      "policyId": "J-itEyD6A7y5S5yYFjxOrb"
    }
  },
  "templateDescription": "templateDescription",
  "templateTitle": "templateTitle",
  "usedBy": 1
}
```

**SDK Code**

```python
import requests

url = "https://api-sandbox.payabli.com/api/Templates/get/80"

headers = {"requestToken": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api-sandbox.payabli.com/api/Templates/get/80';
const options = {method: 'GET', headers: {requestToken: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/Templates/get/80"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("requestToken", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/Templates/get/80")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["requestToken"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/Templates/get/80")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/Templates/get/80', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/Templates/get/80");
var request = new RestRequest(Method.GET);
request.AddHeader("requestToken", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Templates/get/80")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

> If you're a software company, you're a payments company™