Foxpro / Support API / List deleted tickets
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcName
LOCAL lcDeleted_at
LOCAL lcId
LOCAL lcPrevious_state
LOCAL lcSubject
LOCAL lcCount
LOCAL lcNext_page
LOCAL lcPrevious_page
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("sort_by","id")
loQueryParams.UpdateString("sort_order","asc")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://example.zendesk.com/api/v2/deleted_tickets",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcCount = loJResp.StringOf("count")
lcNext_page = loJResp.StringOf("next_page")
lcPrevious_page = loJResp.StringOf("previous_page")
i = 0
lnCount_i = loJResp.SizeOfArray("deleted_tickets")
DO WHILE i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("deleted_tickets[i].actor.id")
lcName = loJResp.StringOf("deleted_tickets[i].actor.name")
lcDeleted_at = loJResp.StringOf("deleted_tickets[i].deleted_at")
lcId = loJResp.StringOf("deleted_tickets[i].id")
lcPrevious_state = loJResp.StringOf("deleted_tickets[i].previous_state")
lcSubject = loJResp.StringOf("deleted_tickets[i].subject")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
