Table of Contents

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

KeyOccursTypeFormatDescription
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"
        }
    ],