TCL / Support API / List Ticket Skips
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "sort_order" "asc"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://example.zendesk.com/api/v2/users/:user_id/skips" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "skips": [
# {
# "created_at": "<dateTime>",
# "id": "<integer>",
# "reason": "<string>",
# "ticket": {
# "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": "urgent",
# "problem_id": "<integer>",
# "raw_subject": "<string>",
# "recipient": "<string>",
# "requester": {},
# "safe_update": "<boolean>",
# "satisfaction_rating": {
# "in_56": -77996997,
# "magnae7": "quis aliqua voluptate et",
# "deseruntc1e": false
# },
# "sharing_agreement_ids": "<array>",
# "status": "closed",
# "subject": "<string>",
# "submitter_id": "<integer>",
# "tags": "<array>",
# "ticket_form_id": "<integer>",
# "type": "task",
# "updated_at": "<dateTime>",
# "updated_stamp": "<string>",
# "url": "<string>",
# "via": {
# "channel": "<string>",
# "source": {
# "utacc": "do aliqua magn",
# "enim049": false,
# "in__": "culpa officia ex non",
# "reprehenderit_06": -27967024
# }
# },
# "via_followup_source_id": "<integer>",
# "via_id": "<integer>",
# "voice_comment": {}
# },
# "ticket_id": "<integer>",
# "updated_at": "<dateTime>",
# "user_id": "<integer>"
# },
# {
# "created_at": "<dateTime>",
# "id": "<integer>",
# "reason": "<string>",
# "ticket": {
# "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": "urgent",
# "problem_id": "<integer>",
# "raw_subject": "<string>",
# "recipient": "<string>",
# "requester": {},
# "safe_update": "<boolean>",
# "satisfaction_rating": {
# "velit_05": -77931495
# },
# "sharing_agreement_ids": "<array>",
# "status": "closed",
# "subject": "<string>",
# "submitter_id": "<integer>",
# "tags": "<array>",
# "ticket_form_id": "<integer>",
# "type": "problem",
# "updated_at": "<dateTime>",
# "updated_stamp": "<string>",
# "url": "<string>",
# "via": {
# "channel": "<string>",
# "source": {
# "tempor__e": -69130011
# }
# },
# "via_followup_source_id": "<integer>",
# "via_id": "<integer>",
# "voice_comment": {}
# },
# "ticket_id": "<integer>",
# "updated_at": "<dateTime>",
# "user_id": "<integer>"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "skips"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set created_at [CkJsonObject_stringOf $jResp "skips[i].created_at"]
set id [CkJsonObject_stringOf $jResp "skips[i].id"]
set reason [CkJsonObject_stringOf $jResp "skips[i].reason"]
set Requester_id [CkJsonObject_stringOf $jResp "skips[i].ticket.requester_id"]
set Allow_attachments [CkJsonObject_stringOf $jResp "skips[i].ticket.allow_attachments"]
set Allow_channelback [CkJsonObject_stringOf $jResp "skips[i].ticket.allow_channelback"]
set Assignee_email [CkJsonObject_stringOf $jResp "skips[i].ticket.assignee_email"]
set Assignee_id [CkJsonObject_stringOf $jResp "skips[i].ticket.assignee_id"]
set Attribute_value_ids [CkJsonObject_stringOf $jResp "skips[i].ticket.attribute_value_ids"]
set Brand_id [CkJsonObject_stringOf $jResp "skips[i].ticket.brand_id"]
set Collaborator_ids [CkJsonObject_stringOf $jResp "skips[i].ticket.collaborator_ids"]
set Created_at [CkJsonObject_stringOf $jResp "skips[i].ticket.created_at"]
set Custom_fields [CkJsonObject_stringOf $jResp "skips[i].ticket.custom_fields"]
set Custom_status_id [CkJsonObject_stringOf $jResp "skips[i].ticket.custom_status_id"]
set Description [CkJsonObject_stringOf $jResp "skips[i].ticket.description"]
set Due_at [CkJsonObject_stringOf $jResp "skips[i].ticket.due_at"]
set Email_cc_ids [CkJsonObject_stringOf $jResp "skips[i].ticket.email_cc_ids"]
set External_id [CkJsonObject_stringOf $jResp "skips[i].ticket.external_id"]
set Follower_ids [CkJsonObject_stringOf $jResp "skips[i].ticket.follower_ids"]
set Followup_ids [CkJsonObject_stringOf $jResp "skips[i].ticket.followup_ids"]
set Forum_topic_id [CkJsonObject_stringOf $jResp "skips[i].ticket.forum_topic_id"]
set From_messaging_channel [CkJsonObject_stringOf $jResp "skips[i].ticket.from_messaging_channel"]
set Group_id [CkJsonObject_stringOf $jResp "skips[i].ticket.group_id"]
set Has_incidents [CkJsonObject_stringOf $jResp "skips[i].ticket.has_incidents"]
set Id [CkJsonObject_stringOf $jResp "skips[i].ticket.id"]
set Is_public [CkJsonObject_stringOf $jResp "skips[i].ticket.is_public"]
set Macro_id [CkJsonObject_stringOf $jResp "skips[i].ticket.macro_id"]
set Macro_ids [CkJsonObject_stringOf $jResp "skips[i].ticket.macro_ids"]
set Organization_id [CkJsonObject_stringOf $jResp "skips[i].ticket.organization_id"]
set Priority [CkJsonObject_stringOf $jResp "skips[i].ticket.priority"]
set Problem_id [CkJsonObject_stringOf $jResp "skips[i].ticket.problem_id"]
set Raw_subject [CkJsonObject_stringOf $jResp "skips[i].ticket.raw_subject"]
set Recipient [CkJsonObject_stringOf $jResp "skips[i].ticket.recipient"]
set Safe_update [CkJsonObject_stringOf $jResp "skips[i].ticket.safe_update"]
set In_56 [CkJsonObject_IntOf $jResp "skips[i].ticket.satisfaction_rating.in_56"]
set Magnae7 [CkJsonObject_stringOf $jResp "skips[i].ticket.satisfaction_rating.magnae7"]
set Deseruntc1e [CkJsonObject_BoolOf $jResp "skips[i].ticket.satisfaction_rating.deseruntc1e"]
set Sharing_agreement_ids [CkJsonObject_stringOf $jResp "skips[i].ticket.sharing_agreement_ids"]
set Status [CkJsonObject_stringOf $jResp "skips[i].ticket.status"]
set Subject [CkJsonObject_stringOf $jResp "skips[i].ticket.subject"]
set Submitter_id [CkJsonObject_stringOf $jResp "skips[i].ticket.submitter_id"]
set Tags [CkJsonObject_stringOf $jResp "skips[i].ticket.tags"]
set Ticket_form_id [CkJsonObject_stringOf $jResp "skips[i].ticket.ticket_form_id"]
set v_Type [CkJsonObject_stringOf $jResp "skips[i].ticket.type"]
set Updated_at [CkJsonObject_stringOf $jResp "skips[i].ticket.updated_at"]
set Updated_stamp [CkJsonObject_stringOf $jResp "skips[i].ticket.updated_stamp"]
set v_Url [CkJsonObject_stringOf $jResp "skips[i].ticket.url"]
set Channel [CkJsonObject_stringOf $jResp "skips[i].ticket.via.channel"]
set Utacc [CkJsonObject_stringOf $jResp "skips[i].ticket.via.source.utacc"]
set Enim049 [CkJsonObject_BoolOf $jResp "skips[i].ticket.via.source.enim049"]
set In__ [CkJsonObject_stringOf $jResp "skips[i].ticket.via.source.in__"]
set Reprehenderit_06 [CkJsonObject_IntOf $jResp "skips[i].ticket.via.source.reprehenderit_06"]
set Via_followup_source_id [CkJsonObject_stringOf $jResp "skips[i].ticket.via_followup_source_id"]
set Via_id [CkJsonObject_stringOf $jResp "skips[i].ticket.via_id"]
set ticket_id [CkJsonObject_stringOf $jResp "skips[i].ticket_id"]
set updated_at [CkJsonObject_stringOf $jResp "skips[i].updated_at"]
set user_id [CkJsonObject_stringOf $jResp "skips[i].user_id"]
set Velit_05 [CkJsonObject_IntOf $jResp "skips[i].ticket.satisfaction_rating.velit_05"]
set Tempor__e [CkJsonObject_IntOf $jResp "skips[i].ticket.via.source.tempor__e"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "skips[i].ticket.collaborators"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set email [CkJsonObject_stringOf $jResp "skips[i].ticket.collaborators[j].email"]
set name [CkJsonObject_stringOf $jResp "skips[i].ticket.collaborators[j].name"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -G -d "sort_order=asc"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/:user_id/skips
Postman Collection Item JSON
{
"name": "List Ticket Skips",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/skips?sort_order=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"skips"
],
"query": [
{
"key": "sort_order",
"value": "asc",
"description": "Sort order. Defaults to \"asc\""
}
],
"variable": [
{
"key": "user_id",
"value": "<integer>"
},
{
"key": "ticket_id",
"value": "<integer>",
"description": "(Required) The ID of the ticket"
}
]
},
"description": "Archived tickets are not included in the response. See\n[About archived tickets](https://support.zendesk.com/hc/en-us/articles/203657756) in\nthe Support Help Center.\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* Agents with \"View only\" or higher reports permissions in Support.\n These permissions are distinct from Explore permissions.\n* Agents retrieving their own skips\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/users/:user_id/skips?sort_order=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"skips"
],
"query": [
{
"key": "sort_order",
"value": "asc",
"description": "Sort order. Defaults to \"asc\""
}
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"skips\": [\n {\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"reason\": \"<string>\",\n \"ticket\": {\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\": \"urgent\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"in_56\": -77996997,\n \"magnae7\": \"quis aliqua voluptate et\",\n \"deseruntc1e\": false\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"closed\",\n \"subject\": \"<string>\",\n \"submitter_id\": \"<integer>\",\n \"tags\": \"<array>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"task\",\n \"updated_at\": \"<dateTime>\",\n \"updated_stamp\": \"<string>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"utacc\": \"do aliqua magn\",\n \"enim049\": false,\n \"in__\": \"culpa officia ex non\",\n \"reprehenderit_06\": -27967024\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n },\n \"ticket_id\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"user_id\": \"<integer>\"\n },\n {\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"reason\": \"<string>\",\n \"ticket\": {\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\": \"urgent\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"velit_05\": -77931495\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"closed\",\n \"subject\": \"<string>\",\n \"submitter_id\": \"<integer>\",\n \"tags\": \"<array>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"problem\",\n \"updated_at\": \"<dateTime>\",\n \"updated_stamp\": \"<string>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"tempor__e\": -69130011\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n },\n \"ticket_id\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"user_id\": \"<integer>\"\n }\n ]\n}"
}
]
}
