...
| _page | unsigned int | The page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources. |
|---|---|---|
| _limit | unsigned int | The maximum number of resources to return. Default is 10 and maximum is 50. |
| _offset | unsigned int | The position in the list of resources to return from. For example, if you had 20 resources and requested an offset of 10. Resources 10 to 19 would be returned. Offset cannot be used in conjunction with _page. |
| _fields | partial string | Allows you to specify optional fields and linked objects to include in the response. |
Filtering staff
You can filter the returned list using the _filters parameter. You can stack filters. For example,_filters=id(21,3),username(abc),standing(active)
Name | Example | Description |
|---|---|---|
| id(...) or id_not(...) | _filters=id(12,3) | |
| email(...) or email_not(...) | _filters=email(abc@example.com) | |
| username(...) or username_not(...) | _filters=username(abc) | |
| standing(...) or standing_not(...) | _filters=standing(active) | |
NEW <field_name>_greater_than(<value>), <field_name>_less_than(<value>), <field_name>_greater_than_or_equal(<value>), <field_name>_less_than_or_equal(<value>)
| _filters=id_greater_than(5) | Available fields: id and rate |
Handling the response
For handling the response, please see GET staff/:id.
...