Get Issues
GET https://api.helpshift.com/v1/{{domain}}/issues
Get all issues using this API. We recommend you to use one or more of the filters so that the response is not too large to manage.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | number | Page Number | |
page-size | number | Number of results per page | |
state_since | number | Fetch issues with state updated after the given timestamp. Alternate spelling: "state-since" | |
state_until | number | Fetch issues with state updated before the given timestamp. Alternate spelling: "state-until" | |
updated_since | number | Fetch issues with any updates after the given timestamp. Alternate spelling: "updated-since" | |
updated_until | number | Fetch issues with any updates before the given timestamp. | |
| Alternate spelling: "updated-until" | |||
created_since | number | Fetch issues created after the given timestamp. Alternate spelling: "created-since" | |
created_until | number | Fetch issues created before the given timestamp. Alternate spelling: "created-until" | |
timestamp-format | string | Format of timestamps in the response. unix: Unix Timestamp (default). iso-8601: ISO-8601 string. | |
sort-order | string | Ascending (asc) or Descending (desc). Default is descending. | |
sort-by | string | Specifies the field by which results will be sorted. Valid values are "creation-time" and "state-change-time" (default). | |
feedback-rating | string | Search for issues by feedback rating. | |
| Format - {"operator" : [{"condition" : "number"}] , "exists" : "true"} | |||
| Operator is one of "and", "or". | |||
| Condition is one of "is", "is_not", "is_greater_than", "is_smaller_than". | |||
feedback-comment | string | Search issues by terms in the feedback comment. | |
| Format - {"and" : ["abc"] , "nor" : ["sdf", "xyz"] , "exists" : "true"} | |||
end-user-ids | string | Search for issues by user-id. | |
author_emails | string | Search for issues by author email. | |
platform-types | string | Search for issues filed with the given platform type. | |
tags | string | Search for issues by tags. | |
| Format - {"and" : ["abc" , "cde"] , "or" : ["hij" , "efg"] , "nor" : ["sdf", "xyz"], "exists" : "true"} | |||
notes | string | Search for issues by terms in private notes. | |
| Format - {"and" : ["abc"] , "or" : ["hij" , "efg"] , "nor" : ["sdf", "xyz"]} | |||
messages | string | Search for issues by terms in messages. | |
| Format - {"and" : ["abc"] , "or" : ["hij" , "efg"] , "nor" : ["sdf", "xyz"]} | |||
state | string | Search by issue state. Valid values - | |
| new, new-for-agent, agent-replied, waiting-for-agent, resolved, rejected and pending-reassignment | |||
languages | string | Search by issue language. | |
| Format - {"and" : ["abc"] , "or" : ["hij" , "efg"] , "nor" : ["sdf", "xyz"], "exists" : "true"} | |||
assignee-ids | string | Search for issues by assigne ID. | |
| Format - {"and" : ["abc"] , "or" : ["hij" , "efg"] , "nor" : ["sdf", "xyz"], "exists" : "true"} | |||
ids | string | Retrieve the given issues by ID. | |
app-ids | string | Retrieve issues for the given app(s). | |
custom_fields | string | Search issues by custom fields. | |
| See APIDocs for format and examples. | |||
includes | string | Optional information to be included in each issue in the response. | |
| Valid values - | |||
| meta - device and custom metadata; | |||
| feedback - feedback rating and comment; | |||
| custom_fields - CIFs; | |||
| private_notes - issue private notes; | |||
| queue - issue queue information; | |||
| predict_labels - current and original predict labels |
RESPONSES
status: OK
{"page":1,"page-size":100,"issues":[{"tags":[],"assignee_name":null,"app_id":"moana_app_20201112130201493-4eb4fd59a188f37","hs_user_id":"moana_profile_1e7f6999de1e7c99e49cf42e1236804ff780c1ec","title":"Issue #850 created using Core API","redacted":false,"updated_at":1606205116230,"messages":[{"body":"Tell ya what, Gromit lad. Let's have a nice hot cup o' tea, eh?","created_at":1606205116230,"author":{"name":"Demigod","id":"moana_profile_1e7f6999de1e7c99e49cf42e1236804ff780c1ec","emails":["meta.homenick@example.net"]},"origin":"end-user","id":"moana_message_20201124080516240-219aedc105e0bb0"}],"assignee_id":"unassigned","id":3,"app_publish_id":"2","author_name":"Meta Homenick","author_email":"meta.homenick@example.net","domain":"moana","state_data":{"state":"new","changed_at":1606205116230},"created_at":1606205116230},{"tags":[],"assignee_name":null,"app_id":"moana_app_20201112130201493-4eb4fd59a188f37","hs_user_id":"moana_profile_27ea4a6456adc718292b7d57a2003397f1885dc5","title":"Huston, we have a problem!","redacted":false,"updated_at":1605781184072,"messages":[{"body":"Huston, we have a problem!","created_at":1605781184072,"author":{"name":"dave","id":"moana_profile_27ea4a6456adc718292b7d57a2003397f1885dc5","emails":["dave@example.com"]},"origin":"end-user","id":"moana_message_20201119101944083-7868144351f95cc"}],"assignee_id":"unassigned","id":2,"app_publish_id":"2","author_name":"dave","author_email":"dave@example.com","domain":"moana","state_data":{"state":"new","changed_at":1605781184072},"created_at":1605781184072},{"tags":[],"assignee_name":null,"app_id":"moana_app_20201112130201493-4eb4fd59a188f37","hs_user_id":"moana_profile_27ea4a6456adc718292b7d57a2003397f1885dc5","title":"Huston, we have a problem!","redacted":false,"updated_at":1605780387912,"messages":[{"body":"Huston, we have a problem!","created_at":1605780387912,"author":{"name":"dave","id":"moana_profile_27ea4a6456adc718292b7d57a2003397f1885dc5","emails":["dave@example.com"]},"origin":"end-user","id":"moana_message_20201119100627940-6561859e1ec4e9f"}],"assignee_id":"unassigned","id":1,"app_publish_id":"2","author_name":"dave","author_email":"dave@example.com","domain":"moana","state_data":{"state":"new","changed_at":1605780387912},"created_at":1605780387912}],"total-hits":3,"total-pages":1}