Filter

You can apply filters to all post list requests. The filterable parameters vary depending on the endpoint and are explained in the documentation.

Filter Params

Every filter item require these 3 parameters (exempt NULL):

Param Name	Param Type	Description
field	string	Name of the field.
type	string	Type of filter as described below.
value	string	Value to filter against. It's always string.

Type	Description	Example
EQ	Equal	`{` `"field": "status",` `"type": "EQ",` `"value": "CLOSED"` `}`
NEQ	Not Equal	`{` `"field": "status",` `"type": "NEQ",` `"value": "CLOSED"` `}`
LT	Less Than, can be used to filter integer, dates, datetimes.	`{` `"field": "createdAt",` `"type": "LT",` `"value": "2023-01-01"` `}`
GT	Greater Than, can be used to filter integer, dates, datetimes.	`{` `"field": "createdAt",` `"type": "GT",` `"value": "2023-01-01"` `}`
LIKE	You can add wildcards sign % before/after or between string you searching for.	`{` `"field": "displayName",` `"type": "LIKE",` `"value": "John%"` `}`
IN	In	`{` `"field": "status",` `"type": "IN",` `"value": "OPEN, CLOSED"` `}`
NOT_IN	Not In	`{` `"field": "status",` `"type": "NOT_IN",` `"value": "OPEN, CLOSED"` `}`
IS_NULL	For this filter value param is not required.	`{` `"field": "phoneNumber",` `"type": "IS_NULL"` `}`
IS_NOT_NULL	For this filter value param is not required.	`{` `"field": "phoneNumber",` `"type": "IS_NOT_NULL"` `}`
MEMBER_OF	Member Of
NOT_MEMBER_OF	Not Member Of

You can order all list requests by orderable fields.

{
    "limit": 5,
    "offset": 0,
    "filter": [],
    "order": [
        {
          "field": "points",
          "order":"DESC"
        }
    ]
}