filter query parameter. Filter availability depends on the specific endpoint.
Syntax
| Part | Description |
|---|---|
field | The field to filter on (varies by endpoint). |
operator | The comparison operator. |
value | The value to compare against. |
Operators
Since operators are not URL-safe, use the encoded values unless your HTTP client handles URL encoding automatically.| Operator | Symbol | URL-encoded |
|---|---|---|
| Equals | = | %3D |
| Greater than | > | %3E |
| Less than | < | %3C |
Example
Filter affiliates to only return those with an active account status:filter parameter.