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

# Get boarding link by template ID

GET https://api-sandbox.payabli.com/api/Boarding/linkbyTemplate/{templateId}

Get details for a boarding link using the boarding template ID. This endpoint requires an application API token.

Reference: https://beta-docs.payabli.com/api-reference/boarding/get-boarding-link-by-template-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

- `acceptOauth` (boolean, optional)
- `acceptRegister` (boolean, optional)
- `builderData` (BuilderData, optional)
- `entryAttributes` (string, optional)
- `id` (long, optional)
- `logo` (FileContent, optional) — Object containing logo file.
- `orgId` (long, optional) — Organization ID. Unique identifier assigned to an org by Payabli.
- `pageIdentifier:` (string, optional) — Auxiliary validation used internally by payment pages and components.
- `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.
- `referenceName` (string, optional)
- `referenceTemplateId` (long, optional)
- `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.

## 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

### BuilderData

- `services` (SSection, optional)
- `attributes` (ASection, optional)
- `banking` (DSection, optional)
- `business` (BSection, optional)
- `owners` (OSection, optional)
- `processing` (PSection, optional)

### FileContent

Contains details about a file. See See [fileObject Object Model](/api-reference/schemas/filecontent) for a complete reference. Max upload size is 30 MB.

- `fContent` (string, optional) — Content of file, Base64-encoded Ignored if furl is specified. Max upload size is 30 MB.
- `filename` (string, optional) — The name of the attached file.
- `ftype` (enum, optional) — The MIME type of the file (if content is provided)
  - Allowed values: `pdf`, `doc`, `docx`, `jpg`, `jpeg`, `png`, `gif`, `txt`
- `furl` (string, optional) — Optional url provided to show or download the file remotely

### SSection

- `ach` (AchSection, optional)
- `card` (CardSection, optional)

### ASection

- `minimumDocuments` (integer, optional)
- `multipleContacts` (boolean, optional)
- `multipleOwners` (boolean, optional)

### DSection

- `depositAccount` (Bnk, optional)
- `withdrawalAccount` (Bnk, optional)

### BSection

- `address` (BAddress, optional)
- `details` (BDetails, optional)

### OSection

- `contact_list` (CList, optional)
- `own_list` (OList, optional)

### PSection

- `avgmonthly` (LinkData, optional)
- `binperson` (LinkData, optional)
- `binphone` (LinkData, optional)
- `binweb` (LinkData, optional)
- `bsummary` (LinkData, optional)
- `highticketamt` (LinkData, optional)
- `mcc` (LinkData, optional)
- `ticketamt` (LinkData, optional)
- `whenCharged` (LinkData, optional)
- `whenDelivered` (LinkData, optional)
- `whenProvided` (LinkData, optional)
- `whenRefunded` (LinkData, optional)

### AchSection

- `acceptance` (AchLinkTypes, optional)
- `fees` (BasicTable, optional)
- `price` (BasicTable, optional)

### CardSection

- `acceptance` (CardLinkTypes, optional)
- `fees` (BasicTable, optional)
- `price` (BasicTable, optional)

### Bnk

- `accountNumber` (LinkData, optional)
- `bankName` (LinkData, optional)
- `routingAccount` (LinkData, optional)
- `typeAccount` (LinkData, optional)

### BAddress

- `baddress` (LinkData, optional)
- `baddress1` (LinkData, optional)
- `bcity` (LinkData, optional)
- `bcountry` (LinkData, optional)
- `bstate` (LinkData, optional)
- `bzip` (LinkData, optional)
- `maddress` (LinkData, optional)
- `maddress1` (LinkData, optional)
- `mcity` (LinkData, optional)
- `mcountry` (LinkData, optional)
- `mstate` (LinkData, optional)
- `mzip` (LinkData, optional)

### BDetails

- `btype` (LinkData, optional)
- `dbaname` (LinkData, optional)
- `ein` (LinkData, optional)
- `faxnumber` (LinkData, optional)
- `legalname` (LinkData, optional)
- `license` (LinkData, optional)
- `licstate` (LinkData, optional)
- `phonenumber` (LinkData, optional)
- `startdate` (LinkData, optional)
- `taxfillname` (LinkData, optional)
- `website` (LinkData, optional)

### CList

- `contactEmail` (LinkData, optional)
- `contactName` (LinkData, optional)
- `contactPhone` (LinkData, optional)
- `contactTitle` (LinkData, optional)

### OList

- `oaddress` (LinkData, optional)
- `ocity` (LinkData, optional)
- `ocountry` (LinkData, optional)
- `odriverstate` (LinkData, optional)
- `ostate` (LinkData, optional)
- `ownerdob` (LinkData, optional)
- `ownerdriver` (LinkData, optional)
- `owneremail` (LinkData, optional)
- `ownername` (LinkData, optional)
- `ownerpercent` (LinkData, optional)
- `ownerphone1` (LinkData, optional)
- `ownerphone2` (LinkData, optional)
- `ownerssn` (LinkData, optional)
- `ownertitle` (LinkData, optional)
- `ozip` (LinkData, optional)

### LinkData

- `ro` (boolean, optional) — When `true`, the element is read-only.
- `rq` (boolean, optional) — When `true`, the element is required.
- `validator` (string, optional) — The type of validation applied to the field. Available values: - text - alpha - ein - url - phone - alphanumeric - zipcode - numbers - float - ssn - email - routing
- `value` (string, optional)

### AchLinkTypes

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

### BasicTable

- `body` (list of LinkRow, optional)
- `header` (LinkRow, optional)

### CardLinkTypes

- `amex` (LinkData, optional)
- `discover` (LinkData, optional)
- `mastercard` (LinkData, optional)
- `visa` (LinkData, optional)

### LinkRow

- `columns` (list of LinkData, optional)

## Examples

**Response**

```json
{
  "acceptOauth": false,
  "acceptRegister": false,
  "builderData": {
    "attributes": {
      "minimumDocuments": 1,
      "multipleContacts": true,
      "multipleOwners": true
    }
  },
  "entryAttributes": "entryAttributes",
  "id": 1000000,
  "logo": {
    "fContent": "TXkgdGVzdCBmaWxlHJ==...",
    "filename": "my-doc.pdf",
    "ftype": "pdf",
    "furl": "https://mysite.com/my-doc.pdf"
  },
  "orgId": 123,
  "pageIdentifier:": "null",
  "recipientEmailNotification": true,
  "referenceName": "payabli-00710",
  "referenceTemplateId": 1830,
  "resumable": false
}
```

**SDK Code**

```python
import requests

url = "https://api-sandbox.payabli.com/api/Boarding/linkbyTemplate/80"

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

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

print(response.json())
```

```javascript
const url = 'https://api-sandbox.payabli.com/api/Boarding/linkbyTemplate/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/Boarding/linkbyTemplate/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/Boarding/linkbyTemplate/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/Boarding/linkbyTemplate/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/Boarding/linkbyTemplate/80', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/Boarding/linkbyTemplate/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/Boarding/linkbyTemplate/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()
```