Params

Param Name Description
search
Optional

Search string


Value:

Must be String

page
Optional

Page number, starting at 1


Value:

Must be a number.

per_page
Optional

Number of results per page to return


Value:

Must be a number.

order
Optional

Sort field and order, eg. 'name DESC'


Value:

Must be String

sort
Optional

Hash version of 'order' param


Value:

Must be a Hash

sort[by]
Optional

Field to sort the results on


Value:

Must be String

sort[order]
Optional

How to order the sorted results (e.g. ASC for ascending)


Value:

Must be String