A list of supported predicates for filtering.
eq (equals)
The eq predicate returns all records where a field is exactly equal to a given value:
https://app.productplan.com/api/v2/roadmaps?q[name_eq]=Adventures of Guybrush Threepwood
Opposite: not_eq
lt (less than)
The lt predicate returns all records where a field is less than a given value:
https://app.productplan.com/api/v2/roadmaps?q[created_at_lt]=2023-01-01
Opposite: gteq (greater than or equal to)
lteq (less than or equal to)
The lteq predicate returns all records where a field is less than or equal to a given value:
https://app.productplan.com/api/v2/roadmaps?q[created_at_lteq]=2023-01-01
Opposite: gt (greater than)
cont
The cont predicate returns all records where a field contains a given value:
https://app.productplan.com/api/v2/roadmaps?q[name_cont]=Guybrush
Opposite: not_cont
i_cont
The i_cont case-insensitive predicate returns all records where a field contains a given value and ignores case:
https://app.productplan.com/api/v2/roadmaps?q[name_i_cont]=guyBRUSH
Opposite: not_i_cont
start (starts with)
The start predicate returns all records where a field begins with a given value:
https://app.productplan.com/api/v2/roadmaps?q[name_start]=Adventures
Opposite: not_start
end (ends with)
The end predicate returns all records where a field ends with a given value:
https://app.productplan.com/api/v2/roadmaps?q[name_end]=Threepwood
Opposite: not_end
true
The true predicate returns all records where a field is true. The '1' indicates that you want to check this field's truthiness. The other truthy values are true, TRUE, t or T.
https://app.productplan.com/api/v2/roadmaps/1/bars?q[parked_true]=1
Opposite: false
present
The present predicate returns all records where a field is present (not null and not a blank string).
https://app.productplan.com/api/v2/roadmaps?q[description_present]=1
Opposite: blank
null
The null predicate returns all records where a field is null:
https://app.productplan.com/api/v2/roadmaps?q[description_null]=1
Opposite: not_null