Get a List of Businesses

Value used to filter the results by the fields provided in the "queryFields" query parameter. By default, the value will be searched for in the following fields: "name", "streetAndNo", "zip", "city", "country", "identifier".

The fields that will be searched to contain the value provided in the "query" query parameter. The default query fields are "name", "streetAndNo", "zip", "city", "country", "identifier

Only return one business based on your internal identification system

Only return businesses identified by ids listed in businessIds

Filter by business status. One of ACTIVE, INACTIVE

Only return businesses with at least minLocations locations

Only returns businesses with at most maxLocations locations

Query accounts by product plan name.

Query accounts by product plan Id.

The business property to sort by (ascending). One of name, streetAndNo, city, zip, phone

Used for pagination. Maximum number of results per page. Default: 10

Offset used for pagination. Default: 0

Possible fieldMask options ('id', 'identifier', 'name', 'type', 'streetAndNo', 'addressLine2', 'province', 'zip', 'city','phone', 'country', 'status', 'canSync', 'dateCreated', 'defaultPrice','defaultOriginalPrice', 'defaultPriceSetup', 'productPlan', 'nextProductPlan', 'numOfLocations')