Ruby / Support API / List deleted tickets
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
http.put_BasicAuth(true)
http.put_Login("login")
http.put_Password("password")
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("sort_by","id")
queryParams.UpdateString("sort_order","asc")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/deleted_tickets",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "deleted_tickets": [
# {
# "actor": {
# "id": "<integer>",
# "name": "<string>"
# },
# "deleted_at": "<string>",
# "id": "<integer>",
# "previous_state": "<string>",
# "subject": "<string>"
# },
# {
# "actor": {
# "id": "<integer>",
# "name": "<string>"
# },
# "deleted_at": "<string>",
# "id": "<integer>",
# "previous_state": "<string>",
# "subject": "<string>"
# }
# ],
# "count": "<integer>",
# "next_page": "<string>",
# "previous_page": "<string>"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
count = jResp.stringOf("count")
next_page = jResp.stringOf("next_page")
previous_page = jResp.stringOf("previous_page")
i = 0
count_i = jResp.SizeOfArray("deleted_tickets")
while i < count_i
jResp.put_I(i)
Id = jResp.stringOf("deleted_tickets[i].actor.id")
Name = jResp.stringOf("deleted_tickets[i].actor.name")
deleted_at = jResp.stringOf("deleted_tickets[i].deleted_at")
id = jResp.stringOf("deleted_tickets[i].id")
previous_state = jResp.stringOf("deleted_tickets[i].previous_state")
subject = jResp.stringOf("deleted_tickets[i].subject")
i = i + 1
end
Curl Command
curl -u login:password -G -d "sort_by=id"
-d "sort_order=asc"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/deleted_tickets
Postman Collection Item JSON
{
"name": "List deleted tickets",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/deleted_tickets?sort_by=id&sort_order=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"deleted_tickets"
],
"query": [
{
"key": "sort_by",
"value": "id",
"description": "Sort by"
},
{
"key": "sort_order",
"value": "asc",
"description": "Sort order. Defaults to \"asc\""
}
]
},
"description": "Returns a maximum of 100 deleted tickets per page. See [Pagination](/api-reference/introduction/pagination/).\n\nThe results includes all deleted (and not yet archived) tickets that\nhave not yet been [scrubbed](https://support.zendesk.com/hc/en-us/articles/4408845703194#topic_fv5_w51_sdb) in the past 30 days. Archived tickets are\nnot included in the results. See [About archived tickets](https://support.zendesk.com/hc/en-us/articles/203657756)\nin the Support Help Center.\n\nThe tickets are ordered chronologically by created date, from oldest to newest.\nThe first ticket listed may not be the oldest ticket in your\naccount due to [ticket archiving](https://support.zendesk.com/hc/en-us/articles/203657756).\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Allowed For\n\n* Agents\n\n#### Rate Limit\n\nYou can make 10 requests every 1 minute using this endpoint.\nWhen making requests beyond page 100, you can make 5 requests every 1 minute.\nThe rate limiting mechanism behaves as described in\n[Monitoring your request activity](/api-reference/ticketing/account-configuration/usage_limits/#monitoring-your-request-activity) in the API introduction."
},
"response": [
{
"name": "Successful response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/deleted_tickets?sort_by=id&sort_order=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"deleted_tickets"
],
"query": [
{
"key": "sort_by",
"value": "id",
"description": "Sort by"
},
{
"key": "sort_order",
"value": "asc",
"description": "Sort order. Defaults to \"asc\""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"deleted_tickets\": [\n {\n \"actor\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\"\n },\n \"deleted_at\": \"<string>\",\n \"id\": \"<integer>\",\n \"previous_state\": \"<string>\",\n \"subject\": \"<string>\"\n },\n {\n \"actor\": {\n \"id\": \"<integer>\",\n \"name\": \"<string>\"\n },\n \"deleted_at\": \"<string>\",\n \"id\": \"<integer>\",\n \"previous_state\": \"<string>\",\n \"subject\": \"<string>\"\n }\n ],\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\"\n}"
}
]
}
