Listing filter JSON

When querying a list through the Volteras Connect API, you can use filters to refine your search. These filters are similar to SQL queries and include field, operator, and value. For instance, make != 'TESLA' uses “make” as the field, ”!=” as the operator, and “TESLA” as the value. The filter is passed as the filter query parameter of the list endpoint. Its value is a JSON string, which needs to be URL-encoded. For example, this filter:

{
  "field": "make",
  "operator": "==",
  "value": "TESLA"
}

is sent as:

curl -G "https://api.volteras.com/v1/vehicles" \
  -H "Authorization: Bearer <access-token>" \
  --data-urlencode 'filter={"field": "make", "operator": "==", "value": "TESLA"}'

Access nested objects using a dot (.). Example:

{
  "field": "metadata.accountId",
  "operator": "==",
  "value": "12345-abcdef-12345-abcdef-12345"
}

For multiple filters, use an array ([]). All the filters in the array have to match. Filters can include boolean functions (or, and, not), which can be nested up to 5 levels deep:

[
  {
    "or": [
      {
        "and": [
          {
            "field": "make",
            "operator": "==",
            "value": "TESLA"
          },
          {
            "field": "metadata.lastSeenAt",
            "operator": ">=",
            "value": "2024-01-01T12:00:00"
          }
        ]
      },
      {
        "not": [
          {
            "field": "vin",
            "operator": "==",
            "value": "5YJ3E1EA7KF317000"
          }
        ]
      }
    ]
  }
]

Note: Use at least one element for or and and, and exactly one for not. Each object holds either a single boolean function or a single filter.

Filter object specification

Property	Type	Description
field	string	Field to apply the filter.
operator	string	Operator used in the filter.
value	string/boolean/int/float/datetime*	Value for the filter. (*) Datetime should be represented as string in ISO format

Boolean functions

Function
`and`
`or`
`not`

Supported operators

Operator
`isNull`
`isNotNull`
`==`
`!=`
`>`
`<`
`>=`
`<=`
`like`
`ilike`
`notIlike`

Overview

Technical Specifications

MCP Server

Listing filter JSON

Filter object specification

Boolean functions

Supported operators

​Filter object specification

​Boolean functions

​Supported operators

Filter object specification

Boolean functions

Supported operators