List all apps for org
Returns a list of boarding applications for an organization. Use filters to limit results.
Path parameters
orgId
The numeric identifier for organization, assigned by Payabli.
Headers
requestToken
Query parameters
fromRecord
The number of records to skip before starting to collect the result set.
limitRecord
Max number of records to return for the query. Use 0
or negative value to return all records.
parameters
Collection of field names, conditions, and values used to filter the query
See Filters and Conditions Reference for help.
List of field names accepted:
- createdAt (gt, ge, lt, le, eq, ne)
- startDate (gt, ge, lt, le, eq, ne)
- dbaname (ct, nct)
- legalname (ct, nct)
- ein (ct, nct)
- address (ct, nct)
- city (ct, nct)
- state (ct, nct)
- phone (ct, nct)
- mcc (ct, nct)
- owntype (ct, nct)
- ownerName (ct, nct)
- contactName (ct, nct)
- status (in, nin, eq,ne)
- orgParentname (ct, nct)
- externalpaypointID (ct, nct, eq, ne)
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
sortBy
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
Records
Summary