Templates

Get boarding template by ID

Retrieves a boarding template's details by ID.

get/Templates/get/{templateId}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Templates/get/{templateId}
  • Auth: HTTP bearer

Path parameters

templateIdnumber double required

The boarding template ID. You can find this at the end of the boarding template URL in the Payabli Portal. Example: https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80. Here, the template ID is 80.

Response

Success

addPriceboolean
createdAtstring date-time

Timestamp of when record was created, in UTC.

idTemplateinteger
isRootboolean

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

orgParentNamestring

The name of the parent organization.

recipientEmailNotificationboolean

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

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

The internal code for the template.

templateDescriptionstring
templateTitlestring
usedByinteger

Changes

No recorded changes to this operation across all 1 revision of this API.