Filtering
To apply a filter use the
filter
query parameter with the format: field:operator:value
?filter=created_at:gt:'2023-11-01T13:00:00Z',and,(id:not:starts_with:0000,or,id:contains:FFFF)
:
is the separator between the field, operator(s) and value.,
can be used to combine filter statements by using ,and,
or ,or,
.(
...)
can be used to group filter statements.'....'
can be used to allow filtering on values with special characters (comma and colon).operator | description |
---|---|
eq | equal to the given value |
gt | greater than the given value |
gte | greater than or equal to the given value |
lt | lesser than the given value |
lte | lesser than or equal to the given value |
not | negation of the operator that follows it |
has | has one or more of a relation |
contains | has occurrence of the given value |
starts_with | starts with the given value |
ends_with | ends with the given value |
Modified at 2024-10-04 09:04:56