Get template

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

addPricebooleanOptional
createdAtdatetimeOptional

Timestamp of when record was created, in UTC.

idTemplatelongOptional
isRootbooleanOptional

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

orgParentNamestringOptional

The name of the parent organization.

recipientEmailNotificationbooleanOptional

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.

resumablebooleanOptional

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.

templateCodestringOptional

The internal code for the template.

templateContentobjectOptional
templateDescriptionstringOptional
templateTitlestringOptional
usedByintegerOptional

Errors