Home
/
API reference
/
API documentation (JSON/XML)
/
Objects
/
JSON specific objects

QueryFilter Object

API reference (XML/JSON) · Updated 2023-10-25

Description

The Filters object defines search criteria for a list query. In XML it corresponds to the object Where. It contains the description of the object to be queried. Information about complex list queries with examples can be found on the List Inquire page.

Structure

Key	Occurs	Type	Format	Description
key	1	string		Name of keyword.
operator	0 - 1	enum	OperatorType	Comparison operator.
value	1	string		Value after which filtering is to be performed.

JSON Example

    "filters": [
        {
            "key": "name",
            "operator": "LIKE",
            "value": "example"
        }
    ],