List Requests threads

Resource URL

GET /requests/threads

Description

This endpoint will get the requests based on certain filters applied to the activity threads that are linked with the request. See GET /requests for getting requests with queries unrelated to activities.

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
request_is_claimed(<boolean>)	request_is_claimed(1)	If true, only returns claimed requests. If false, only returns unclaimed requests.
request_type_id(<type_ids>)	request_type_id(1, 2)	Returns the request threads of the type_ids
show_inactive_type(<boolean>)	show_inactive_type(1)	If true, will show requests from inactive types. By default, this endpoint will not return requests of inactive type
interact_from_staff(<staff_ids>)	interact_from_staff(1,2,3)	Returns the requests that have been interacted from staffs of the staff_ids
date_created_before(<unix_timestamp>)		Returns the requests that are created before the timestamp
date_created_after(<unix_timestamp>)		Returns the requests that are created after the timestamp
order_by_date_created(<boolean>)		If true, orders requests by the date created in ascending order. Else, orders request by date created in descending order
standing(<statuses>)	standing('pending','open','converted')	Accepts: 'pending','open','converted','closed'
order_by_desc_latest_external_interaction(<boolean>)		If true, orders requests by latest external interaction. In this case external refers to non-staff
date_created_before(<unix timestamp>), date_created_after(<unix timestamp>)

Fields

You can use fields to control what to be returned

Name	Example	Description
latest_respond_body		Includes the latest response body of the requests