Foxpro / Support API / Search Requests
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcSubject
LOCAL lcAssignee_id
LOCAL lcCan_be_solved_by_me
LOCAL lcCreated_at
LOCAL lcCustom_status_id
LOCAL lcDescription
LOCAL lcDue_at
LOCAL lcFollowup_source_id
LOCAL lcGroup_id
LOCAL lcId
LOCAL lcIs_public
LOCAL lcOrganization_id
LOCAL lcPriority
LOCAL lcRecipient
LOCAL lcRequester_id
LOCAL lcSolved
LOCAL lcStatus
LOCAL lcTicket_form_id
LOCAL lcV_type
LOCAL lcUpdated_at
LOCAL lcUrl
LOCAL lcChannel
LOCAL lcSitde
LOCAL lnId80
LOCAL lnEsse2a
LOCAL lnIrure_8
LOCAL lcIn77
LOCAL lcNisi_0
LOCAL j
LOCAL lnCount_j
LOCAL lcStrVal
LOCAL lcValue
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"
loHttp.SetRequestHeader("Accept","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/requests/search",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* 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 = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "requests": [
* {
* "subject": "<string>",
* "assignee_id": "<integer>",
* "can_be_solved_by_me": "<boolean>",
* "collaborator_ids": [
* "<integer>",
* "<integer>"
* ],
* "created_at": "<dateTime>",
* "custom_fields": [
* {
* "id": "<integer>",
* "value": "<string>"
* },
* {
* "id": "<integer>",
* "value": "<string>"
* }
* ],
* "custom_status_id": "<integer>",
* "description": "<string>",
* "due_at": "<dateTime>",
* "email_cc_ids": [
* "<integer>",
* "<integer>"
* ],
* "followup_source_id": "<integer>",
* "group_id": "<integer>",
* "id": "<integer>",
* "is_public": "<boolean>",
* "organization_id": "<integer>",
* "priority": "<string>",
* "recipient": "<string>",
* "requester_id": "<integer>",
* "solved": "<boolean>",
* "status": "<string>",
* "ticket_form_id": "<integer>",
* "type": "<string>",
* "updated_at": "<dateTime>",
* "url": "<string>",
* "via": {
* "channel": "<string>",
* "source": {
* "sitde": -5925380.425592765,
* "id80": false
* }
* }
* },
* {
* "subject": "<string>",
* "assignee_id": "<integer>",
* "can_be_solved_by_me": "<boolean>",
* "collaborator_ids": [
* "<integer>",
* "<integer>"
* ],
* "created_at": "<dateTime>",
* "custom_fields": [
* {
* "id": "<integer>",
* "value": "<string>"
* },
* {
* "id": "<integer>",
* "value": "<string>"
* }
* ],
* "custom_status_id": "<integer>",
* "description": "<string>",
* "due_at": "<dateTime>",
* "email_cc_ids": [
* "<integer>",
* "<integer>"
* ],
* "followup_source_id": "<integer>",
* "group_id": "<integer>",
* "id": "<integer>",
* "is_public": "<boolean>",
* "organization_id": "<integer>",
* "priority": "<string>",
* "recipient": "<string>",
* "requester_id": "<integer>",
* "solved": "<boolean>",
* "status": "<string>",
* "ticket_form_id": "<integer>",
* "type": "<string>",
* "updated_at": "<dateTime>",
* "url": "<string>",
* "via": {
* "channel": "<string>",
* "source": {
* "esse2a": false,
* "irure_8": true,
* "in77": 99886237.33060426,
* "nisi_0": "occaecat velit voluptate consequat"
* }
* }
* }
* ]
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i = 0
lnCount_i = loJResp.SizeOfArray("requests")
DO WHILE i < lnCount_i
loJResp.I = i
lcSubject = loJResp.StringOf("requests[i].subject")
lcAssignee_id = loJResp.StringOf("requests[i].assignee_id")
lcCan_be_solved_by_me = loJResp.StringOf("requests[i].can_be_solved_by_me")
lcCreated_at = loJResp.StringOf("requests[i].created_at")
lcCustom_status_id = loJResp.StringOf("requests[i].custom_status_id")
lcDescription = loJResp.StringOf("requests[i].description")
lcDue_at = loJResp.StringOf("requests[i].due_at")
lcFollowup_source_id = loJResp.StringOf("requests[i].followup_source_id")
lcGroup_id = loJResp.StringOf("requests[i].group_id")
lcId = loJResp.StringOf("requests[i].id")
lcIs_public = loJResp.StringOf("requests[i].is_public")
lcOrganization_id = loJResp.StringOf("requests[i].organization_id")
lcPriority = loJResp.StringOf("requests[i].priority")
lcRecipient = loJResp.StringOf("requests[i].recipient")
lcRequester_id = loJResp.StringOf("requests[i].requester_id")
lcSolved = loJResp.StringOf("requests[i].solved")
lcStatus = loJResp.StringOf("requests[i].status")
lcTicket_form_id = loJResp.StringOf("requests[i].ticket_form_id")
lcV_type = loJResp.StringOf("requests[i].type")
lcUpdated_at = loJResp.StringOf("requests[i].updated_at")
lcUrl = loJResp.StringOf("requests[i].url")
lcChannel = loJResp.StringOf("requests[i].via.channel")
lcSitde = loJResp.StringOf("requests[i].via.source.sitde")
lnId80 = loJResp.BoolOf("requests[i].via.source.id80")
lnEsse2a = loJResp.BoolOf("requests[i].via.source.esse2a")
lnIrure_8 = loJResp.BoolOf("requests[i].via.source.irure_8")
lcIn77 = loJResp.StringOf("requests[i].via.source.in77")
lcNisi_0 = loJResp.StringOf("requests[i].via.source.nisi_0")
j = 0
lnCount_j = loJResp.SizeOfArray("requests[i].collaborator_ids")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("requests[i].collaborator_ids[j]")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("requests[i].custom_fields")
DO WHILE j < lnCount_j
loJResp.J = j
lcId = loJResp.StringOf("requests[i].custom_fields[j].id")
lcValue = loJResp.StringOf("requests[i].custom_fields[j].value")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("requests[i].email_cc_ids")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("requests[i].email_cc_ids[j]")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/requests/search
Postman Collection Item JSON
{
"name": "Search Requests",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/requests/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"requests",
"search"
],
"variable": [
{
"key": "query",
"value": "<string>",
"description": "The syntax and matching logic for the string is detailed in the [Zendesk Support search reference](https://support.zendesk.com/hc/en-us/articles/203663226). See also [Query basics](/api-reference/ticketing/ticket-management/search/#query-basics) in the Tickets API doc."
}
]
},
"description": "Examples:\n\n* `GET /api/v2/requests/search.json?query=printer`\n* `GET /api/v2/requests/search.json?query=printer&organization_id=1`\n* `GET /api/v2/requests/search.json?query=printer&cc_id=true`\n* `GET /api/v2/requests/search.json?query=printer&status=hold,open`\n\n#### Pagination\n\n* Offset pagination only\n\nSee [Using Offset Pagination](/api-reference/ticketing/introduction/#using-offset-pagination).\n\n#### Results limit\n\nThe Search Requests endpoint returns up to 1,000 results per query, with a maximum of 100 results per page. See [Pagination](/api-reference/ticketing/introduction/#pagination). If you request a page past the limit (`page=11` at 100 results per page), a 422 Insufficient Resource Error is returned.\n\n#### Allowed For\n\n* End Users\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/requests/search",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"requests",
"search"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"requests\": [\n {\n \"subject\": \"<string>\",\n \"assignee_id\": \"<integer>\",\n \"can_be_solved_by_me\": \"<boolean>\",\n \"collaborator_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"created_at\": \"<dateTime>\",\n \"custom_fields\": [\n {\n \"id\": \"<integer>\",\n \"value\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"value\": \"<string>\"\n }\n ],\n \"custom_status_id\": \"<integer>\",\n \"description\": \"<string>\",\n \"due_at\": \"<dateTime>\",\n \"email_cc_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"followup_source_id\": \"<integer>\",\n \"group_id\": \"<integer>\",\n \"id\": \"<integer>\",\n \"is_public\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"priority\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester_id\": \"<integer>\",\n \"solved\": \"<boolean>\",\n \"status\": \"<string>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"sitde\": -5925380.425592765,\n \"id80\": false\n }\n }\n },\n {\n \"subject\": \"<string>\",\n \"assignee_id\": \"<integer>\",\n \"can_be_solved_by_me\": \"<boolean>\",\n \"collaborator_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"created_at\": \"<dateTime>\",\n \"custom_fields\": [\n {\n \"id\": \"<integer>\",\n \"value\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"value\": \"<string>\"\n }\n ],\n \"custom_status_id\": \"<integer>\",\n \"description\": \"<string>\",\n \"due_at\": \"<dateTime>\",\n \"email_cc_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"followup_source_id\": \"<integer>\",\n \"group_id\": \"<integer>\",\n \"id\": \"<integer>\",\n \"is_public\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"priority\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester_id\": \"<integer>\",\n \"solved\": \"<boolean>\",\n \"status\": \"<string>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"esse2a\": false,\n \"irure_8\": true,\n \"in77\": 99886237.33060426,\n \"nisi_0\": \"occaecat velit voluptate consequat\"\n }\n }\n }\n ]\n}"
}
]
}
