v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB

Account

Search Accounts

Search for Account entities.

This endpoint executes a search query for Accounts based on the user specified search criteria. The search query is customizable, allowing for complex nested conditions and sorting. The returned list of Accounts can be paginated for easier management.

get/organizations/{orgId}/accounts/search

Path parameters

orgIdstring required

UUID of the Organization.

Query parameters

searchQuerystring

Query for data using special syntax:

Query parameters should be delimited using the $ (dollar sign).
Allowed comparators are:
- (greater than) >
- (greater than or equal to) >=
- (equal to) :
- (less than) <
- (less than or equal to) <=
- (match phrase/prefix) ~
Allowed parameters are: name, code, currency, purchaseOrderNumber, parentAccountId, codes, id, createdBy, dtCreated, lastModifiedBy, ids.
Query example:
- searchQuery=name~Premium On$currency:USD.
- This query is translated into: find accounts whose name contains the phrase/prefix 'Premium On' AND the account currency is USD.

Note: Using the ~ match phrase/prefix comparator. For best results, we recommend treating this as a "starts with" comparator for your search query.

fromDocumentinteger

fromDocument for multi page retrievals.

pageSizeinteger

Number of Accounts to retrieve per page.

NOTE: If not defined, default is 10.

operator'AND' | 'OR'

Search Operator to be used while querying search.

sortBystring

Name of the parameter on which sorting is performed. Use any field available on the Account entity to sort by, such as name, code, and so on.

sortOrder'ASC' | 'DESC'

Sorting order.

Response

Return the Accounts that match the search criteria

nextTokenstring

Example response

{
  "data": [
    {
      "currency": "USD"
    }
  ]
}