LogoLogo
Status PageContact sales
DevelopersIntegration guidesEmbedded componentsSDKs & toolsAPI reference
  • Using the API
    • API overview
    • API responses
  • API
  • Webhooks
Status PageContact sales
APIPay Ops endpointsBoardingTemplates

Get template

GET
/Templates/get/:templateId
GET
/api/Templates/get/:templateId
1curl https://api-sandbox.payabli.com/api/Templates/get/80 \
2     -H "requestToken: <apiKey>"
Try it
1{
2  "addPrice": true,
3  "boardingLinks": [
4    {
5      "acceptOauth": false,
6      "acceptRegister": false,
7      "entryAttributes": "entryAttributes",
8      "id": 91,
9      "lastUpdated": "2022-07-01T15:00:01Z",
10      "orgParentName": "PropertyManager Pro",
11      "referenceName": "payabli-00710",
12      "referenceTemplateId": 1830,
13      "templateCode": "templateCode",
14      "templateName": "SMB"
15    }
16  ],
17  "createdAt": "2022-07-01T15:00:01Z",
18  "idTemplate": 1000000,
19  "isRoot": false,
20  "orgParentName": "PropertyManager Pro",
21  "recipientEmailNotification": true,
22  "resumable": false,
23  "templateCode": "templateCode",
24  "templateContent": {
25    "businessData": {
26      "visible": true
27    },
28    "documentsData": {
29      "subFooter": "subFooter",
30      "subHeader": "subHeader",
31      "minimumDocuments": 1,
32      "uploadDocuments": true,
33      "visible": true
34    },
35    "ownershipData": {
36      "multipleContacts": true,
37      "multipleOwners": true,
38      "subFooter": "subFooter",
39      "subHeader": "subHeader",
40      "visible": true
41    },
42    "processingData": {
43      "subFooter": "subFooter",
44      "subHeader": "subHeader",
45      "visible": true
46    },
47    "salesData": {
48      "salesCode": "salesCode",
49      "salesCRM": "salesCRM"
50    },
51    "servicesData": {
52      "subFooter": "subFooter",
53      "subHeader": "subHeader",
54      "visible": true
55    },
56    "underwritingData": {
57      "method": "automatic",
58      "policyId": "J-itEyD6A7y5S5yYFjxOrb"
59    }
60  },
61  "templateDescription": "templateDescription",
62  "templateTitle": "templateTitle",
63  "usedBy": 1
64}
Retrieves a boarding template's details by ID.

Path parameters

templateIddoubleRequired
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`.

Headers

requestTokenstringRequired

Response

Success
addPriceboolean or null
boardingLinkslist of objects or null
createdAtdatetime or null
Timestamp of when record was created, in UTC.
idTemplatelong or null
isRootboolean or null

When true, indicates that this is the organization’s root template.

orgParentNamestring or null
The name of the parent organization.
recipientEmailNotificationboolean or null

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.

resumableboolean or null

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.

templateCodestring or null
The internal code for the template.
templateContentobject or null
templateDescriptionstring or null
templateTitlestring or null
usedByinteger or null

Errors

Was this page helpful?
Previous

List templates

Next
Built with
Success

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.