- Home
- API reference
- API documentation (JSON/XML)
- Objects
- XML specific objects
Where Object
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
| Key | Occurs | Typ | Format | Description |
|---|---|---|---|---|
| key | 0 - 1 | string | The keyword | |
| operator | 0 - 1 | enum | OperatorType | The comparison operator |
| value | 0 - 1 | string | The value contained within the keyword |
XML Example
<where>
<key>name</key>
<operator>eq</operator>
<value>domain.com</value>
</where>