Basic sorting, filtering and pagination operations can be performed through the use of query string parameters.
The following are standard query string operations.
Limits the number of results returned.
limit=5 would limit the result set to 5 items.
Changes the start position of the results selected.
offset=3 would skip the first 3 items and start the result set at the 4th item.
Returns a specific page of a paginated result set.
page=2 would return the 2nd page of a result set.
Sorts the result set by a specific field.
sort=account would return the results sorted by the account field, in ascending order.
sort=-account would return the results sorted by the account field, in descending order.
Loads a related item with the request.
with=account would return the associated account object.
Field Specific Operations
In addition to standard operations, filtering operations can be performed on any field in the output.
amount-st=1 would return objects where the amount field is < 1.
amount-gt=1 would return objects where the amount field is > 1.
greater than or equal to
amount-min=1 would return objects where the amount is > or = 1.
less than or equal to
amount-max=1 would return objects where the amount is < or = 1.
account-lk=%bill% would return objects where account contains "bill".
account-not-lk=%bill% would return objects where account does not contain "bill".
id-in=1,2,3 would return objects where id is equal to 1, 2 or 3.
id-not-in=1,2,3 would return objects where id is not equal to 1, 2 or 3.
not equals to
bank_id-not=20 would return objects where bank_id is not equal to 20.