Table of contents

Description

The where Object is responsible for defining the search criteria in a search query. In JSON this corresponds to the Filters object. Information about complex list queries with examples can be found on the List Inquire page.

Structure

KeyOccursTypFormatDescription
key0 - 1string

The keyword

operator0 - 1enumOperatorTypeThe comparison operator
value0 - 1string
The value contained within the keyword

XML Example

<where>
    <key>name</key>
    <operator>eq</operator>
    <value>domain.com</value>
</where>