List Requests
Resource URL
GET /requests
Parameters
Table of allowed parameters.
| _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. |
| _filters | partial_string |
Filtering
You can filter the returned list using the _filters parameter.
| Name | Example | Description |
|---|---|---|
| id | ||
| max_id | ||
| min_id | ||
| standing(<statuses>) | Accepts: 'pending','open','converted','closed' | |
| affiliation(<ids>) | ||
| type(<ids>) | ||
| priority(<ids>) | ||
| lead(<ids>) | ||
| date_created_before(<unix timestamp>), date_created_after(<unix timestamp>) | ||
| order_by_desc(<type>), order_by_asc(<type>) | Accepts: date_created and id. |
Using the _not suffix (e.g, id_not) on standard in filters will returns results not in.
Handling the response
Please see GET /requests/:id for handling the response.