> 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. # List templates GET https://api-sandbox.payabli.com/api/Query/templates/{orgId} Retrieves a list of boarding templates for an organization. Use filters to limit results. You can't make a request that includes filters from the API console in the documentation. The response will not be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client. Reference: https://beta-docs.payabli.com/api-reference/templates/get-list-of-boarding-templates-for-organization ## 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 - `orgId` (integer, required) — The numeric identifier for organization, assigned by Payabli. ### Query parameters - `fromRecord` (integer, optional, default: 0) — The number of records to skip before starting to collect the result set. - `limitRecord` (integer, optional, default: 20) — Max number of records to return for the query. Use `0` or negative value to return all records. - `parameters` (map from string to string, optional) — Collection of field names, conditions, and values used to filter the query. **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.** Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client. For example: \--url [https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000\&limitRecord=20](https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount\(gt\)=1000\&limitRecord=20) should become: \--url [https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000\&limitRecord=20](https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount\(gt\)=1000\&limitRecord=20) See [Filters and Conditions Reference](/developer-guides/reporting-filters-and-conditions-reference) for help. List of field names accepted: * createdAt (gt, ge, lt, le, eq, ne) * title (ct, nct) * description (ct, nct) * code (ct, nct) * orgParentname (ct, nct) List of comparison accepted - enclosed between parentheses: * eq or empty => equal * gt => greater than * ge => greater or equal * lt => less than * le => less or equal * ne => not equal * ct => contains * nct => not contains * in => inside array * nin => not inside array List of parameters accepted: * limitRecord : max number of records for query (default="20", "0" or negative value for all) * fromRecord : initial record in query Example: title(ct)=hoa return all records with title containing "hoa" - `sortBy` (string, optional) — The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`. ## Response ### 200 Success - `records` (list of TemplateQueryRecord, optional) - `summary` (QuerySummary, 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 ### TemplateQueryRecord - `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) ### QuerySummary - `pageIdentifier` (string, optional) — Auxiliary validation used internally by payment pages and components. - `pageSize` (integer, optional) — Number of records on each response page. - `totalAmount` (double, optional) — Total amount for the records. - `totalNetAmount` (double, optional) — Total net amount for the records. - `totalPages` (integer, optional) — Total number of records in response. - `totalRecords` (integer, optional) — Total number of records in response. ### 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 { "records": [ { "addPrice": true, "boardingLinks": [ { "id": 91 } ], "createdAt": "2022-07-01T15:00:01Z", "idTemplate": 1000000, "isRoot": false, "orgParentName": "PropertyManager Pro", "recipientEmailNotification": true, "resumable": false, "templateCode": "templateCode", "templateDescription": "templateDescription", "templateTitle": "templateTitle", "usedBy": 1 } ], "summary": { "pageIdentifier": "null", "pageSize": 20, "totalAmount": 77.22, "totalNetAmount": 77.22, "totalPages": 2, "totalRecords": 2 } } ``` **SDK Code** ```python import requests url = "https://api-sandbox.payabli.com/api/Query/templates/123" querystring = {"fromRecord":"251","limitRecord":"0","sortBy":"desc(field_name)"} headers = {"requestToken": ""} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api-sandbox.payabli.com/api/Query/templates/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29'; const options = {method: 'GET', headers: {requestToken: ''}}; 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/Query/templates/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("requestToken", "") 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/Query/templates/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["requestToken"] = '' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Query/templates/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") .header("requestToken", "") .asString(); ``` ```php request('GET', 'https://api-sandbox.payabli.com/api/Query/templates/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api-sandbox.payabli.com/api/Query/templates/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29"); var request = new RestRequest(Method.GET); request.AddHeader("requestToken", ""); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/templates/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")! 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() ```