Query parameters
Some endpoints have query parameters that allow for RHS (right hand side) colon syntax. Please consult the Swagger documentation to see which endpoints support RHS parameters. This allows for more flexible usage of the API.
RHS operators
The following RHS operators can be supported
| Operator | The requested value must | Example |
|---|---|---|
| eq (equals) | Match the following value exactly | eq:success |
| in (in) | Be in one of the following values | in:agreed,disagreed |
| like (like) | Contain the following value | like:customer+name |
Sorting
Some endpoints support sorting using the RHS colon syntax. Please consult the Swagger documentation to see which sorting values are available on the endpoint.
The sorting query parameter follows the format of value:direction, where the direction is either asc (ascending) or desc (descending).
For example:
createdAt:descid:asc