Get List of Boarding Templates for Org

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.

Authorizations

requestToken · string · header · required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

orgId · integer · required

The numeric identifier for organization, assigned by Payabli.

Example:

123

Query Parameters

parameters · object

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. For example, --url '<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'

See See 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"

limitRecord · integer · default: 20

Max number of records to return for the query. Use 0 or negative value to return all records.

Example:

0

fromRecord · integer · default: 0

The number of records to skip before starting to collect the result set.

Example:

251

sortBy · string

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.

Example:

"desc(field_name)"

Response

200 - application/json

Success

The response is of type object.