Visual FoxPro Zendesk: Search for Open Tickets

Back to Index

Search and return JSON for open tickets.

Documentation: https://developer.zendesk.com/rest_api/docs/core/search

CURL Command

curl -X GET https://subdomain.zendesk.com/api/v2/search.json \
  -H "Accept: application/json" \
  --data-urlencode "query=type:ticket status:open" \
  -u zendesk_email:zendesk_password

Visual FoxPro Example

LOCAL loRest
LOCAL lnSuccess
LOCAL lnBTls
LOCAL lnPort
LOCAL lnBAutoReconnect
LOCAL lcStrResponseBody
LOCAL lnRespStatusCode
LOCAL loJsonResponse
LOCAL lcFacets
LOCAL lcNext_page
LOCAL lcPrevious_page
LOCAL lnCount
LOCAL i
LOCAL lnCount_i
LOCAL lcUrl
LOCAL lnId
LOCAL lcExternal_id
LOCAL lcViaChannel
LOCAL lcViaSourceRel
LOCAL lcCreated_at
LOCAL lcUpdated_at
LOCAL lcType
LOCAL lcSubject
LOCAL lcRaw_subject
LOCAL lcDescription
LOCAL lcPriority
LOCAL lcStatus
LOCAL lcRecipient
LOCAL lnRequester_id
LOCAL lnSubmitter_id
LOCAL lnAssignee_id
LOCAL lnOrganization_id
LOCAL lnGroup_id
LOCAL lcForum_topic_id
LOCAL lcProblem_id
LOCAL lnHas_incidents
LOCAL lnIs_public
LOCAL lcDue_at
LOCAL lcSatisfaction_rating
LOCAL lnBrand_id
LOCAL lnAllow_channelback
LOCAL lcResult_type
LOCAL j
LOCAL lnCount_j
LOCAL lcStrVal

loRest = CreateObject('Chilkat_9_5_0.Rest')

*  URL: https://subdomain.zendesk.com/api/v2/search.json
lnBTls = 1
lnPort = 443
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("subdomain.zendesk.com",lnPort,lnBTls,lnBAutoReconnect)
IF (lnSuccess <> 1) THEN
    ? "ConnectFailReason: " + STR(loRest.ConnectFailReason)
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
ENDIF

loRest.SetAuthBasic("zendesk_email","zendesk_password")

loRest.AddQueryParam("query","type:ticket status:open")

loRest.AddHeader("Accept","application/json")

lcStrResponseBody = loRest.FullRequestFormUrlEncoded("GET","/api/v2/search.json")
IF (loRest.LastMethodSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    CANCEL
ENDIF

lnRespStatusCode = loRest.ResponseStatusCode
IF (lnRespStatusCode >= 400) THEN
    ? "Response Status Code = " + STR(lnRespStatusCode)
    ? "Response Header:"
    ? loRest.ResponseHeader
    ? "Response Body:"
    ? lcStrResponseBody
    RELEASE loRest
    CANCEL
ENDIF

loJsonResponse = CreateObject('Chilkat_9_5_0.JsonObject')
loJsonResponse.Load(lcStrResponseBody)

lcFacets = loJsonResponse.StringOf("facets")
lcNext_page = loJsonResponse.StringOf("next_page")
lcPrevious_page = loJsonResponse.StringOf("previous_page")
lnCount = loJsonResponse.IntOf("count")
i = 0
lnCount_i = loJsonResponse.SizeOfArray("results")
DO WHILE i < lnCount_i
    loJsonResponse.I = i
    lcUrl = loJsonResponse.StringOf("results[i].url")
    lnId = loJsonResponse.IntOf("results[i].id")
    lcExternal_id = loJsonResponse.StringOf("results[i].external_id")
    lcViaChannel = loJsonResponse.StringOf("results[i].via.channel")
    lcViaSourceRel = loJsonResponse.StringOf("results[i].via.source.rel")
    lcCreated_at = loJsonResponse.StringOf("results[i].created_at")
    lcUpdated_at = loJsonResponse.StringOf("results[i].updated_at")
    lcType = loJsonResponse.StringOf("results[i].type")
    lcSubject = loJsonResponse.StringOf("results[i].subject")
    lcRaw_subject = loJsonResponse.StringOf("results[i].raw_subject")
    lcDescription = loJsonResponse.StringOf("results[i].description")
    lcPriority = loJsonResponse.StringOf("results[i].priority")
    lcStatus = loJsonResponse.StringOf("results[i].status")
    lcRecipient = loJsonResponse.StringOf("results[i].recipient")
    lnRequester_id = loJsonResponse.IntOf("results[i].requester_id")
    lnSubmitter_id = loJsonResponse.IntOf("results[i].submitter_id")
    lnAssignee_id = loJsonResponse.IntOf("results[i].assignee_id")
    lnOrganization_id = loJsonResponse.IntOf("results[i].organization_id")
    lnGroup_id = loJsonResponse.IntOf("results[i].group_id")
    lcForum_topic_id = loJsonResponse.StringOf("results[i].forum_topic_id")
    lcProblem_id = loJsonResponse.StringOf("results[i].problem_id")
    lnHas_incidents = loJsonResponse.BoolOf("results[i].has_incidents")
    lnIs_public = loJsonResponse.BoolOf("results[i].is_public")
    lcDue_at = loJsonResponse.StringOf("results[i].due_at")
    lcSatisfaction_rating = loJsonResponse.StringOf("results[i].satisfaction_rating")
    lnBrand_id = loJsonResponse.IntOf("results[i].brand_id")
    lnAllow_channelback = loJsonResponse.BoolOf("results[i].allow_channelback")
    lcResult_type = loJsonResponse.StringOf("results[i].result_type")
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("results[i].collaborator_ids")
    DO WHILE j < lnCount_j
        loJsonResponse.J = j
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("results[i].follower_ids")
    DO WHILE j < lnCount_j
        loJsonResponse.J = j
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("results[i].email_cc_ids")
    DO WHILE j < lnCount_j
        loJsonResponse.J = j
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("results[i].tags")
    DO WHILE j < lnCount_j
        loJsonResponse.J = j
        lcStrVal = loJsonResponse.StringOf("results[i].tags[j]")
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("results[i].custom_fields")
    DO WHILE j < lnCount_j
        loJsonResponse.J = j
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("results[i].sharing_agreement_ids")
    DO WHILE j < lnCount_j
        loJsonResponse.J = j
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("results[i].fields")
    DO WHILE j < lnCount_j
        loJsonResponse.J = j
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJsonResponse.SizeOfArray("results[i].followup_ids")
    DO WHILE j < lnCount_j
        loJsonResponse.J = j
        j = j + 1
    ENDDO
    i = i + 1
ENDDO

RELEASE loRest
RELEASE loJsonResponse

Sample JSON Response Body

{
  "results": [
    {
      "url": "https://chilkat.zendesk.com/api/v2/tickets/4.json",
      "id": 4,
      "external_id": null,
      "via": {
        "channel": "web",
        "source": {
          "from": {},
          "to": {},
          "rel": null
        }
      },
      "created_at": "2018-04-14T21:06:06Z",
      "updated_at": "2018-04-14T21:06:06Z",
      "type": "incident",
      "subject": "Fix bug in software",
      "raw_subject": "Fix bug in software",
      "description": "Fix a bug in the software...",
      "priority": "urgent",
      "status": "open",
      "recipient": null,
      "requester_id": 361801727573,
      "submitter_id": 361801727573,
      "assignee_id": 361801727573,
      "organization_id": 360015071793,
      "group_id": 360000681553,
      "collaborator_ids": [
      ],
      "follower_ids": [
      ],
      "email_cc_ids": [
      ],
      "forum_topic_id": null,
      "problem_id": null,
      "has_incidents": false,
      "is_public": true,
      "due_at": null,
      "tags": [
        "bug"
      ],
      "custom_fields": [
      ],
      "satisfaction_rating": null,
      "sharing_agreement_ids": [
      ],
      "fields": [
      ],
      "followup_ids": [
      ],
      "brand_id": 360000471533,
      "allow_channelback": false,
      "result_type": "ticket"
    },
    {
      "url": "https://chilkat.zendesk.com/api/v2/tickets/3.json",
      "id": 3,
      "external_id": null,
      "via": {
        "channel": "web",
        "source": {
          "from": {},
          "to": {},
          "rel": null
        }
      },
      "created_at": "2018-04-14T21:03:21Z",
      "updated_at": "2018-04-14T21:03:21Z",
      "type": "task",
      "subject": "Add cool new feature.",
      "raw_subject": "Add cool new feature.",
      "description": "Add a cool new feature to the product.",
      "priority": "high",
      "status": "open",
      "recipient": null,
      "requester_id": 361801727573,
      "submitter_id": 361801727573,
      "assignee_id": 361801727573,
      "organization_id": 360015071793,
      "group_id": 360000681553,
      "collaborator_ids": [
      ],
      "follower_ids": [
      ],
      "email_cc_ids": [
      ],
      "forum_topic_id": null,
      "problem_id": null,
      "has_incidents": false,
      "is_public": true,
      "due_at": "2018-04-18T17:00:00Z",
      "tags": [
        "cool",
        "feature"
      ],
      "custom_fields": [
      ],
      "satisfaction_rating": null,
      "sharing_agreement_ids": [
      ],
      "fields": [
      ],
      "followup_ids": [
      ],
      "brand_id": 360000471533,
      "allow_channelback": false,
      "result_type": "ticket"
    },
    {
      "url": "https://chilkat.zendesk.com/api/v2/tickets/1.json",
      "id": 1,
      "external_id": null,
      "via": {
        "channel": "sample_ticket",
        "source": {
          "from": {},
          "to": {},
          "rel": null
        }
      },
      "created_at": "2018-04-14T19:01:56Z",
      "updated_at": "2018-04-14T19:01:57Z",
      "type": "incident",
      "subject": "Sample ticket: Meet the ticket",
      "raw_subject": "Sample ticket: Meet the ticket",
      "description": "Hi Matt,\n\nEmails, chats, voicemails, and tweets are captured in Zendesk Support as tickets. Start typing above to respond and click Submit to send. To test how an email becomes a ticket, send a message to support@chilkat.zendesk.com.\n\nCurious about what your customers will see when you reply? Check out this video:\nhttps://demos.zendesk.com/hc/en-us/articles/202341799\n",
      "priority": "normal",
      "status": "open",
      "recipient": null,
      "requester_id": 361809055094,
      "submitter_id": 361801727573,
      "assignee_id": 361801727573,
      "organization_id": null,
      "group_id": 360000681553,
      "collaborator_ids": [
      ],
      "follower_ids": [
      ],
      "email_cc_ids": [
      ],
      "forum_topic_id": null,
      "problem_id": null,
      "has_incidents": false,
      "is_public": true,
      "due_at": null,
      "tags": [
        "sample",
        "support",
        "zendesk"
      ],
      "custom_fields": [
      ],
      "satisfaction_rating": null,
      "sharing_agreement_ids": [
      ],
      "fields": [
      ],
      "followup_ids": [
      ],
      "brand_id": 360000471533,
      "allow_channelback": false,
      "result_type": "ticket"
    }
  ],
  "facets": null,
  "next_page": null,
  "previous_page": null,
  "count": 3
}