Chilkat Online Tools

Python / Support API / List Tickets

Back to Collection Items

import sys
import chilkat2

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = chilkat2.Http()

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

queryParams = chilkat2.JsonObject()
queryParams.UpdateString("external_id","<string>")

http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/tickets",queryParams)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

print("Response Body:")
print(jResp.Emit())

respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.Header)
    print("Failed.")

    sys.exit()

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "tickets": [
#     {
#       "requester_id": "<integer>",
#       "allow_attachments": "<boolean>",
#       "allow_channelback": "<boolean>",
#       "assignee_email": "<string>",
#       "assignee_id": "<integer>",
#       "attribute_value_ids": "<array>",
#       "brand_id": "<integer>",
#       "collaborator_ids": "<array>",
#       "collaborators": [
#         {
#           "email": "<email>",
#           "name": "<string>"
#         },
#         {
#           "email": "<email>",
#           "name": "<string>"
#         }
#       ],
#       "comment": {},
#       "created_at": "<dateTime>",
#       "custom_fields": "<array>",
#       "custom_status_id": "<integer>",
#       "description": "<string>",
#       "due_at": "<dateTime>",
#       "email_cc_ids": "<array>",
#       "email_ccs": {},
#       "external_id": "<string>",
#       "follower_ids": "<array>",
#       "followers": {},
#       "followup_ids": "<array>",
#       "forum_topic_id": "<integer>",
#       "from_messaging_channel": "<boolean>",
#       "group_id": "<integer>",
#       "has_incidents": "<boolean>",
#       "id": "<integer>",
#       "is_public": "<boolean>",
#       "macro_id": "<integer>",
#       "macro_ids": "<array>",
#       "metadata": {},
#       "organization_id": "<integer>",
#       "priority": "normal",
#       "problem_id": "<integer>",
#       "raw_subject": "<string>",
#       "recipient": "<string>",
#       "requester": {},
#       "safe_update": "<boolean>",
#       "satisfaction_rating": {
#         "magnaae": 84328139.5577608,
#         "nisi19": true
#       },
#       "sharing_agreement_ids": "<array>",
#       "status": "new",
#       "subject": "<string>",
#       "submitter_id": "<integer>",
#       "tags": "<array>",
#       "ticket_form_id": "<integer>",
#       "type": "question",
#       "updated_at": "<dateTime>",
#       "updated_stamp": "<string>",
#       "url": "<string>",
#       "via": {
#         "channel": "<string>",
#         "source": {
#           "veniam_79": 90804961.49951228
#         }
#       },
#       "via_followup_source_id": "<integer>",
#       "via_id": "<integer>",
#       "voice_comment": {}
#     },
#     {
#       "requester_id": "<integer>",
#       "allow_attachments": "<boolean>",
#       "allow_channelback": "<boolean>",
#       "assignee_email": "<string>",
#       "assignee_id": "<integer>",
#       "attribute_value_ids": "<array>",
#       "brand_id": "<integer>",
#       "collaborator_ids": "<array>",
#       "collaborators": [
#         {
#           "email": "<email>",
#           "name": "<string>"
#         },
#         {
#           "email": "<email>",
#           "name": "<string>"
#         }
#       ],
#       "comment": {},
#       "created_at": "<dateTime>",
#       "custom_fields": "<array>",
#       "custom_status_id": "<integer>",
#       "description": "<string>",
#       "due_at": "<dateTime>",
#       "email_cc_ids": "<array>",
#       "email_ccs": {},
#       "external_id": "<string>",
#       "follower_ids": "<array>",
#       "followers": {},
#       "followup_ids": "<array>",
#       "forum_topic_id": "<integer>",
#       "from_messaging_channel": "<boolean>",
#       "group_id": "<integer>",
#       "has_incidents": "<boolean>",
#       "id": "<integer>",
#       "is_public": "<boolean>",
#       "macro_id": "<integer>",
#       "macro_ids": "<array>",
#       "metadata": {},
#       "organization_id": "<integer>",
#       "priority": "high",
#       "problem_id": "<integer>",
#       "raw_subject": "<string>",
#       "recipient": "<string>",
#       "requester": {},
#       "safe_update": "<boolean>",
#       "satisfaction_rating": {
#         "eu_b": 33777312
#       },
#       "sharing_agreement_ids": "<array>",
#       "status": "hold",
#       "subject": "<string>",
#       "submitter_id": "<integer>",
#       "tags": "<array>",
#       "ticket_form_id": "<integer>",
#       "type": "incident",
#       "updated_at": "<dateTime>",
#       "updated_stamp": "<string>",
#       "url": "<string>",
#       "via": {
#         "channel": "<string>",
#         "source": {
#           "id2": "cillum minim et",
#           "eiusmod_13": -64405368,
#           "occaecat1db": 1792444.0305951983
#         }
#       },
#       "via_followup_source_id": "<integer>",
#       "via_id": "<integer>",
#       "voice_comment": {}
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

i = 0
count_i = jResp.SizeOfArray("tickets")
while i < count_i :
    jResp.I = i
    requester_id = jResp.StringOf("tickets[i].requester_id")
    allow_attachments = jResp.StringOf("tickets[i].allow_attachments")
    allow_channelback = jResp.StringOf("tickets[i].allow_channelback")
    assignee_email = jResp.StringOf("tickets[i].assignee_email")
    assignee_id = jResp.StringOf("tickets[i].assignee_id")
    attribute_value_ids = jResp.StringOf("tickets[i].attribute_value_ids")
    brand_id = jResp.StringOf("tickets[i].brand_id")
    collaborator_ids = jResp.StringOf("tickets[i].collaborator_ids")
    created_at = jResp.StringOf("tickets[i].created_at")
    custom_fields = jResp.StringOf("tickets[i].custom_fields")
    custom_status_id = jResp.StringOf("tickets[i].custom_status_id")
    description = jResp.StringOf("tickets[i].description")
    due_at = jResp.StringOf("tickets[i].due_at")
    email_cc_ids = jResp.StringOf("tickets[i].email_cc_ids")
    external_id = jResp.StringOf("tickets[i].external_id")
    follower_ids = jResp.StringOf("tickets[i].follower_ids")
    followup_ids = jResp.StringOf("tickets[i].followup_ids")
    forum_topic_id = jResp.StringOf("tickets[i].forum_topic_id")
    from_messaging_channel = jResp.StringOf("tickets[i].from_messaging_channel")
    group_id = jResp.StringOf("tickets[i].group_id")
    has_incidents = jResp.StringOf("tickets[i].has_incidents")
    id = jResp.StringOf("tickets[i].id")
    is_public = jResp.StringOf("tickets[i].is_public")
    macro_id = jResp.StringOf("tickets[i].macro_id")
    macro_ids = jResp.StringOf("tickets[i].macro_ids")
    organization_id = jResp.StringOf("tickets[i].organization_id")
    priority = jResp.StringOf("tickets[i].priority")
    problem_id = jResp.StringOf("tickets[i].problem_id")
    raw_subject = jResp.StringOf("tickets[i].raw_subject")
    recipient = jResp.StringOf("tickets[i].recipient")
    safe_update = jResp.StringOf("tickets[i].safe_update")
    Magnaae = jResp.StringOf("tickets[i].satisfaction_rating.magnaae")
    Nisi19 = jResp.BoolOf("tickets[i].satisfaction_rating.nisi19")
    sharing_agreement_ids = jResp.StringOf("tickets[i].sharing_agreement_ids")
    status = jResp.StringOf("tickets[i].status")
    subject = jResp.StringOf("tickets[i].subject")
    submitter_id = jResp.StringOf("tickets[i].submitter_id")
    tags = jResp.StringOf("tickets[i].tags")
    ticket_form_id = jResp.StringOf("tickets[i].ticket_form_id")
    v_type = jResp.StringOf("tickets[i].type")
    updated_at = jResp.StringOf("tickets[i].updated_at")
    updated_stamp = jResp.StringOf("tickets[i].updated_stamp")
    url = jResp.StringOf("tickets[i].url")
    Channel = jResp.StringOf("tickets[i].via.channel")
    Veniam_79 = jResp.StringOf("tickets[i].via.source.veniam_79")
    via_followup_source_id = jResp.StringOf("tickets[i].via_followup_source_id")
    via_id = jResp.StringOf("tickets[i].via_id")
    Eu_b = jResp.IntOf("tickets[i].satisfaction_rating.eu_b")
    Id2 = jResp.StringOf("tickets[i].via.source.id2")
    Eiusmod_13 = jResp.IntOf("tickets[i].via.source.eiusmod_13")
    Occaecat1db = jResp.StringOf("tickets[i].via.source.occaecat1db")
    j = 0
    count_j = jResp.SizeOfArray("tickets[i].collaborators")
    while j < count_j :
        jResp.J = j
        email = jResp.StringOf("tickets[i].collaborators[j].email")
        name = jResp.StringOf("tickets[i].collaborators[j].name")
        j = j + 1

    i = i + 1

Curl Command

curl  -u login:password -G -d "external_id=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/tickets

Postman Collection Item JSON

{
  "name": "List Tickets",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/tickets?external_id=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "tickets"
      ],
      "query": [
        {
          "key": "external_id",
          "value": "<string>",
          "description": "Lists tickets by external id. External ids don't have to be unique for each ticket. As a result, the request may return multiple tickets with the same external id."
        }
      ]
    }
  },
  "response": [
    {
      "name": "List tickets",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/tickets?external_id=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "tickets"
          ],
          "query": [
            {
              "key": "external_id",
              "value": "<string>",
              "description": "Lists tickets by external id. External ids don't have to be unique for each ticket. As a result, the request may return multiple tickets with the same external id."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"tickets\": [\n    {\n      \"requester_id\": \"<integer>\",\n      \"allow_attachments\": \"<boolean>\",\n      \"allow_channelback\": \"<boolean>\",\n      \"assignee_email\": \"<string>\",\n      \"assignee_id\": \"<integer>\",\n      \"attribute_value_ids\": \"<array>\",\n      \"brand_id\": \"<integer>\",\n      \"collaborator_ids\": \"<array>\",\n      \"collaborators\": [\n        {\n          \"email\": \"<email>\",\n          \"name\": \"<string>\"\n        },\n        {\n          \"email\": \"<email>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"comment\": {},\n      \"created_at\": \"<dateTime>\",\n      \"custom_fields\": \"<array>\",\n      \"custom_status_id\": \"<integer>\",\n      \"description\": \"<string>\",\n      \"due_at\": \"<dateTime>\",\n      \"email_cc_ids\": \"<array>\",\n      \"email_ccs\": {},\n      \"external_id\": \"<string>\",\n      \"follower_ids\": \"<array>\",\n      \"followers\": {},\n      \"followup_ids\": \"<array>\",\n      \"forum_topic_id\": \"<integer>\",\n      \"from_messaging_channel\": \"<boolean>\",\n      \"group_id\": \"<integer>\",\n      \"has_incidents\": \"<boolean>\",\n      \"id\": \"<integer>\",\n      \"is_public\": \"<boolean>\",\n      \"macro_id\": \"<integer>\",\n      \"macro_ids\": \"<array>\",\n      \"metadata\": {},\n      \"organization_id\": \"<integer>\",\n      \"priority\": \"normal\",\n      \"problem_id\": \"<integer>\",\n      \"raw_subject\": \"<string>\",\n      \"recipient\": \"<string>\",\n      \"requester\": {},\n      \"safe_update\": \"<boolean>\",\n      \"satisfaction_rating\": {\n        \"magnaae\": 84328139.5577608,\n        \"nisi19\": true\n      },\n      \"sharing_agreement_ids\": \"<array>\",\n      \"status\": \"new\",\n      \"subject\": \"<string>\",\n      \"submitter_id\": \"<integer>\",\n      \"tags\": \"<array>\",\n      \"ticket_form_id\": \"<integer>\",\n      \"type\": \"question\",\n      \"updated_at\": \"<dateTime>\",\n      \"updated_stamp\": \"<string>\",\n      \"url\": \"<string>\",\n      \"via\": {\n        \"channel\": \"<string>\",\n        \"source\": {\n          \"veniam_79\": 90804961.49951228\n        }\n      },\n      \"via_followup_source_id\": \"<integer>\",\n      \"via_id\": \"<integer>\",\n      \"voice_comment\": {}\n    },\n    {\n      \"requester_id\": \"<integer>\",\n      \"allow_attachments\": \"<boolean>\",\n      \"allow_channelback\": \"<boolean>\",\n      \"assignee_email\": \"<string>\",\n      \"assignee_id\": \"<integer>\",\n      \"attribute_value_ids\": \"<array>\",\n      \"brand_id\": \"<integer>\",\n      \"collaborator_ids\": \"<array>\",\n      \"collaborators\": [\n        {\n          \"email\": \"<email>\",\n          \"name\": \"<string>\"\n        },\n        {\n          \"email\": \"<email>\",\n          \"name\": \"<string>\"\n        }\n      ],\n      \"comment\": {},\n      \"created_at\": \"<dateTime>\",\n      \"custom_fields\": \"<array>\",\n      \"custom_status_id\": \"<integer>\",\n      \"description\": \"<string>\",\n      \"due_at\": \"<dateTime>\",\n      \"email_cc_ids\": \"<array>\",\n      \"email_ccs\": {},\n      \"external_id\": \"<string>\",\n      \"follower_ids\": \"<array>\",\n      \"followers\": {},\n      \"followup_ids\": \"<array>\",\n      \"forum_topic_id\": \"<integer>\",\n      \"from_messaging_channel\": \"<boolean>\",\n      \"group_id\": \"<integer>\",\n      \"has_incidents\": \"<boolean>\",\n      \"id\": \"<integer>\",\n      \"is_public\": \"<boolean>\",\n      \"macro_id\": \"<integer>\",\n      \"macro_ids\": \"<array>\",\n      \"metadata\": {},\n      \"organization_id\": \"<integer>\",\n      \"priority\": \"high\",\n      \"problem_id\": \"<integer>\",\n      \"raw_subject\": \"<string>\",\n      \"recipient\": \"<string>\",\n      \"requester\": {},\n      \"safe_update\": \"<boolean>\",\n      \"satisfaction_rating\": {\n        \"eu_b\": 33777312\n      },\n      \"sharing_agreement_ids\": \"<array>\",\n      \"status\": \"hold\",\n      \"subject\": \"<string>\",\n      \"submitter_id\": \"<integer>\",\n      \"tags\": \"<array>\",\n      \"ticket_form_id\": \"<integer>\",\n      \"type\": \"incident\",\n      \"updated_at\": \"<dateTime>\",\n      \"updated_stamp\": \"<string>\",\n      \"url\": \"<string>\",\n      \"via\": {\n        \"channel\": \"<string>\",\n        \"source\": {\n          \"id2\": \"cillum minim et\",\n          \"eiusmod_13\": -64405368,\n          \"occaecat1db\": 1792444.0305951983\n        }\n      },\n      \"via_followup_source_id\": \"<integer>\",\n      \"via_id\": \"<integer>\",\n      \"voice_comment\": {}\n    }\n  ]\n}"
    }
  ]
}