Requests
Search requests using customer, assignment, date, status, and custom-field filters
Omit reporting_tags to search without a tag filter. When supplied, it must contain 1–100 distinct tag names; an empty array returns 422.
get/requests/search
Request
- Base URL: https://helpspot.example.com/api/v2
- URL: https://helpspot.example.com/api/v2/requests/search
- Auth: one of:
- HTTP bearer
- HTTP basic
Query parameters
querystring
match'any' | 'all'
request_idinteger
customer_idstring
first_namestring
last_namestring
emailstring email
phonestring
openboolean
category_idinteger
assigned_staff_idinteger
status_idinteger
reporting_tags[]string[]
custom_fields[]string[]
before_dateinteger
after_dateinteger
closed_before_dateinteger
closed_after_dateinteger
relative_date'today' | 'tomorrow' | 'yesterday' | 'past_7' | 'past_14' | 'past_30' | 'past_60' | 'past_90' | 'past_365' | 'this_week' | 'this_month' | 'this_year' | 'last_week' | 'last_month' | 'last_year' | 'next_7' | 'next_14' | 'next_30' | 'next_90' | 'next_365' | 'next_week' | 'next_month' | 'next_year' | 'date_is_set' | 'date_is_not_set'
order_bystring
direction'asc' | 'desc'
offsetinteger
per_pageinteger
include_time_totalboolean
Response
Request resource. Fields depend on visibility and endpoint; see the Requests guide.
Changes
No recorded changes to this operation across all 1 revision of this API.