Boarding

Get list of boarding links for organization

Return a list of boarding links for an organization. Use filters to limit results.

get/Query/boardinglinks/{orgId}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Query/boardinglinks/{orgId}
  • Auth: HTTP bearer

Path parameters

orgIdinteger required

The numeric identifier for organization, assigned by Payabli.

Query parameters

fromRecordinteger

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

limitRecordinteger

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

parametersobject

Collection of field names, conditions, and values used to filter the query

See Filters and Conditions Reference for help.

Accepted field names:

  • lastUpdated (gt, ge, lt, le, eq, ne)
  • templateName (ct, nct)
  • referenceName (ct, nct)
  • acceptRegister (eq, ne)
  • acceptAuth (eq, ne)
  • templateCode (ct, nct)
  • templateId (eq, ne)
  • orgParentname (ct, nct)

Accepted comparison operators - 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

Accepted parameters:

  • limitRecord : max number of records for query (default="20", "0" or negative value for all)
  • fromRecord : initial record in query

Example: templateName(ct)=hoa return all records with template title containing "hoa"

sortBystring

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

Success

Changes

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