API Filtering

API filtering can be done with a simple request body object using key/value pairs.

Exact Match Filtering

{
  "filters": {
    "name": "John"
  }
}

The above example will return any result with the "name" of "John" using an exact match search.

Wildcard Filtering

We have a few different variations for wildcards, each which are illustrated below.

{
  "filters": {
    "name": "%John%" ,
    "param2": "*John*",
    "param3": "*John",
    "param4": "John*"
  }
}

All of the above filters work and produce the same result. They are different variations depending on your preference. All of the API variations need to be passed as string.

Date / Timestamp Operator Filtering

We accept a valid list of the following operators:
">", "<", "<=", ">=", "="

This can currently be used on date-time or timestamp fields, most commonly used for created_at, updated_at dates.

Example JSON

{
  "filters": {
    {  
       "updated_at":[  
          "=",
          "2017-09-29"
       ]
    }
  }
}