Skip to main content
Version: 1.38

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

OperatorThe requested value mustExample
eq (equals)Match the following value exactlyeq:success
in (in)Be in one of the following valuesin:agreed,disagreed
like (like)Contain the following valuelike: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:desc
  • id:asc