Query Options
Every action=list endpoint across the IWDR API accepts the same set of optional query string parameters for
filtering, searching, and paginating results. Include these directly in the request URL alongside table and
action.
- Name
q- Type
- string
- Description
A powerful query string to filter the returned data. The string format is as follows: (field~operator~value). For example, (dog_DogID~equals~1). To search using multiple fields just add another query set. For example (field1~equals~4)(field2~equals~6). The available operators are as follows:
- equals
- notequal
- morethan
- lessthan
- contains
- between
- empty
- startswith
- Name
qs- Type
- string
- Description
A generic search string. This acts a general "all fields" search string.
- Name
records- Type
- integer
- Description
The number of records to be returned. If number is more than all records owned, then all records will be returned.
By default, a maximum of 200 records are shown per request. To retrieve more than 200 records this parameter must be adjusted.
- Name
skip- Type
- integer
- Description
The number of records to skip over. This parameter combined with the "records" parameter can be used to simulate a simple pagination functionality.