Get list of organizations for a parent
Retrieves a list of an organization's suborganizations and their full details such as orgId, users, and settings. Use filters to limit results. Include the exportFormat query parameter to return the results as a file instead of a JSON response.
Request
- Base URL: https://api-sandbox.payabli.com/api
- URL: https://api-sandbox.payabli.com/api/Query/organizations/{orgId}
- Auth: HTTP bearer
Path parameters
The numeric identifier for organization, assigned by Payabli.
Query parameters
Export format for file downloads. When specified, returns data as a file instead of JSON.
Export format for file downloads. When specified, returns data as a file instead of JSON.
The number of records to skip before starting to collect the result set.
Max number of records to return for the query. Use 0 or negative value to return all records.
Collection of field names, conditions, and values used to filter the query. <Info> 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:
should become:
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20 </Info> Accepted field names:
- 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)
- orgParentname (ct, nct)
- boardingId (eq, ne)
- entryName (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: dbaname(ct)=hoa returns all records with a dbaname containing "hoa"
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.