Business Manager API Documentation

Getting Started

Coming soon...

API Testing Setup

Coming soon...

Lists and filters

The filter parameter that is available on standard endpoints using the GET method, without an id parameter, allows the following options:

  • By default, the LIKE operator is used find the filter value in all columns.
  • In order to pass multiple filter values, separate each with a +. The resulting SQL query uses the OR operator for each passed filter on all columns.
  • If no + operator is used, the whole filter passed will be used as one value regardless of spaces.
  • In order to filter on a specific column the following formats are available for each passed filter:
    • {column}:{value} using a colon will cause the query to use the LIKE operator.
    • {column}|{value} using a line will cause the query to use the = operator for exact value matches.