Node.js / Support API / List Ticket Skips
Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
http.BasicAuth = true;
http.Login = "login";
http.Password = "password";
var queryParams = new chilkat.JsonObject();
queryParams.UpdateString("sort_order","asc");
http.SetRequestHeader("Accept","application/json");
// resp: HttpResponse
var resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/users/:user_id/skips",queryParams);
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
var sbResponseBody = new chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(resp.Header);
console.log("Failed.");
return;
}
// 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
var created_at;
var id;
var reason;
var Requester_id;
var Allow_attachments;
var Allow_channelback;
var Assignee_email;
var Assignee_id;
var Attribute_value_ids;
var Brand_id;
var Collaborator_ids;
var Created_at;
var Custom_fields;
var Custom_status_id;
var Description;
var Due_at;
var Email_cc_ids;
var External_id;
var Follower_ids;
var Followup_ids;
var Forum_topic_id;
var From_messaging_channel;
var Group_id;
var Has_incidents;
var Id;
var Is_public;
var Macro_id;
var Macro_ids;
var Organization_id;
var Priority;
var Problem_id;
var Raw_subject;
var Recipient;
var Safe_update;
var In_56;
var Magnae7;
var Deseruntc1e;
var Sharing_agreement_ids;
var Status;
var Subject;
var Submitter_id;
var Tags;
var Ticket_form_id;
var v_Type;
var Updated_at;
var Updated_stamp;
var v_Url;
var Channel;
var Utacc;
var Enim049;
var In__;
var Reprehenderit_06;
var Via_followup_source_id;
var Via_id;
var ticket_id;
var updated_at;
var user_id;
var Velit_05;
var Tempor__e;
var j;
var count_j;
var email;
var name;
var i = 0;
var count_i = jResp.SizeOfArray("skips");
while (i < count_i) {
jResp.I = i;
created_at = jResp.StringOf("skips[i].created_at");
id = jResp.StringOf("skips[i].id");
reason = jResp.StringOf("skips[i].reason");
Requester_id = jResp.StringOf("skips[i].ticket.requester_id");
Allow_attachments = jResp.StringOf("skips[i].ticket.allow_attachments");
Allow_channelback = jResp.StringOf("skips[i].ticket.allow_channelback");
Assignee_email = jResp.StringOf("skips[i].ticket.assignee_email");
Assignee_id = jResp.StringOf("skips[i].ticket.assignee_id");
Attribute_value_ids = jResp.StringOf("skips[i].ticket.attribute_value_ids");
Brand_id = jResp.StringOf("skips[i].ticket.brand_id");
Collaborator_ids = jResp.StringOf("skips[i].ticket.collaborator_ids");
Created_at = jResp.StringOf("skips[i].ticket.created_at");
Custom_fields = jResp.StringOf("skips[i].ticket.custom_fields");
Custom_status_id = jResp.StringOf("skips[i].ticket.custom_status_id");
Description = jResp.StringOf("skips[i].ticket.description");
Due_at = jResp.StringOf("skips[i].ticket.due_at");
Email_cc_ids = jResp.StringOf("skips[i].ticket.email_cc_ids");
External_id = jResp.StringOf("skips[i].ticket.external_id");
Follower_ids = jResp.StringOf("skips[i].ticket.follower_ids");
Followup_ids = jResp.StringOf("skips[i].ticket.followup_ids");
Forum_topic_id = jResp.StringOf("skips[i].ticket.forum_topic_id");
From_messaging_channel = jResp.StringOf("skips[i].ticket.from_messaging_channel");
Group_id = jResp.StringOf("skips[i].ticket.group_id");
Has_incidents = jResp.StringOf("skips[i].ticket.has_incidents");
Id = jResp.StringOf("skips[i].ticket.id");
Is_public = jResp.StringOf("skips[i].ticket.is_public");
Macro_id = jResp.StringOf("skips[i].ticket.macro_id");
Macro_ids = jResp.StringOf("skips[i].ticket.macro_ids");
Organization_id = jResp.StringOf("skips[i].ticket.organization_id");
Priority = jResp.StringOf("skips[i].ticket.priority");
Problem_id = jResp.StringOf("skips[i].ticket.problem_id");
Raw_subject = jResp.StringOf("skips[i].ticket.raw_subject");
Recipient = jResp.StringOf("skips[i].ticket.recipient");
Safe_update = jResp.StringOf("skips[i].ticket.safe_update");
In_56 = jResp.IntOf("skips[i].ticket.satisfaction_rating.in_56");
Magnae7 = jResp.StringOf("skips[i].ticket.satisfaction_rating.magnae7");
Deseruntc1e = jResp.BoolOf("skips[i].ticket.satisfaction_rating.deseruntc1e");
Sharing_agreement_ids = jResp.StringOf("skips[i].ticket.sharing_agreement_ids");
Status = jResp.StringOf("skips[i].ticket.status");
Subject = jResp.StringOf("skips[i].ticket.subject");
Submitter_id = jResp.StringOf("skips[i].ticket.submitter_id");
Tags = jResp.StringOf("skips[i].ticket.tags");
Ticket_form_id = jResp.StringOf("skips[i].ticket.ticket_form_id");
v_Type = jResp.StringOf("skips[i].ticket.type");
Updated_at = jResp.StringOf("skips[i].ticket.updated_at");
Updated_stamp = jResp.StringOf("skips[i].ticket.updated_stamp");
v_Url = jResp.StringOf("skips[i].ticket.url");
Channel = jResp.StringOf("skips[i].ticket.via.channel");
Utacc = jResp.StringOf("skips[i].ticket.via.source.utacc");
Enim049 = jResp.BoolOf("skips[i].ticket.via.source.enim049");
In__ = jResp.StringOf("skips[i].ticket.via.source.in__");
Reprehenderit_06 = jResp.IntOf("skips[i].ticket.via.source.reprehenderit_06");
Via_followup_source_id = jResp.StringOf("skips[i].ticket.via_followup_source_id");
Via_id = jResp.StringOf("skips[i].ticket.via_id");
ticket_id = jResp.StringOf("skips[i].ticket_id");
updated_at = jResp.StringOf("skips[i].updated_at");
user_id = jResp.StringOf("skips[i].user_id");
Velit_05 = jResp.IntOf("skips[i].ticket.satisfaction_rating.velit_05");
Tempor__e = jResp.IntOf("skips[i].ticket.via.source.tempor__e");
j = 0;
count_j = jResp.SizeOfArray("skips[i].ticket.collaborators");
while (j < count_j) {
jResp.J = j;
email = jResp.StringOf("skips[i].ticket.collaborators[j].email");
name = jResp.StringOf("skips[i].ticket.collaborators[j].name");
j = j+1;
}
i = i+1;
}
}
chilkatExample();
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}"
}
]
}
