Query Parameters

Basic sorting, filtering and pagination operations can be performed through the use of query string parameters.

Standard Operations

The following are standard query string operations.

limit

Limits the number of results returned.
limit=5 would limit the result set to 5 items.

offset

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.

page

Returns a specific page of a paginated result set.
page=2 would return the 2nd page of a result set.

sort

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.

with

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.

st

smaller than
amount-st=1 would return objects where the amount field is < 1.

gt

greater than
amount-gt=1 would return objects where the amount field is > 1.

min

greater than or equal to
amount-min=1 would return objects where the amount is > or = 1.

max

less than or equal to
amount-max=1 would return objects where the amount is < or = 1.

lk

like
account-lk=%bill% would return objects where account contains "bill".

not-lk

not like
account-not-lk=%bill% would return objects where account does not contain "bill".

in

in
id-in=1,2,3 would return objects where id is equal to 1, 2 or 3.

not-in

not in
id-not-in=1,2,3 would return objects where id is not equal to 1, 2 or 3.

not

not equals to
bank_id-not=20 would return objects where bank_id is not equal to 20.