Filtering

Almost all endpoints what returns list of data. Supports filter query parameter with paging combination.

Filter query parameter

filter=attribute|operation|value;attribute2|operation|value

Only specific properties support some filter groups.

Filter groups

Group

Operations

EQUALS

eq, ne

NUMBER

gt, gteq, lt, lteq

STRING

like

ENUM

in

BITS

bin, bex

NULL

Filter operations

Operation

Full name

Example

SQL representation

gt

Greater than

price|gt|499.9

price > 499.9

gteq

Greater than or equals

price|gteq|500

price >= 500

lt

Less than

price|lt|100

price < 100

lteq

Less than or equals

price|lteq|50

price <= 50

eq

Equals

type|eq|sale

type = 'sale'

ne

Not equal

type|ne|sale

type != 'sale'

like

Contains text (case insensitive)

name|like|text

name ILIKE '%text%'

in

Is in a set

deleted|in|0,1

deleted IN (0, 1)

bin

Bits are set in a bit field

flags|bin|17

flags & 17 = 17

bex

Bits not set in a bit field

flags|bex|15

flags & 15 = 0

Filter examples

Description

Filter query parameter

Get only deleted items

filter=deleted|eq|1

Get deleted and non deleted items

filter=deleted|in|0,1

Get interval for price <500, 1000>

filter=price|gteq|500;price|lteq|1000

Get date interval for created <FROM, TO)

filter=created|gteq|FROM;created|lt|TO