The following macros are not currently supported in the header:
  • style

GET /requests

List Requests

Resource URL

GET /requests

Parameters

Table of allowed parameters.

_pageunsigned intThe page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources.
_limitunsigned intThe maximum number of resources to return. Default is 10 and maximum is 50.
_offsetunsigned intThe 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.
_fieldspartial stringAllows you to specify optional fields and linked objects to include in the response.
_filterspartial_string 

Filtering

You can filter the returned list using the _filters parameter.

NameExampleDescription
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.

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
type
progressed_by
lead
affiliation
priority

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.

Â