SQL Server / Support API / List Tickets
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'login'
EXEC sp_OASetProperty @http, 'Password', 'password'
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'external_id', '<string>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://example.zendesk.com/api/v2/tickets', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- 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
DECLARE @requester_id nvarchar(4000)
DECLARE @allow_attachments nvarchar(4000)
DECLARE @allow_channelback nvarchar(4000)
DECLARE @assignee_email nvarchar(4000)
DECLARE @assignee_id nvarchar(4000)
DECLARE @attribute_value_ids nvarchar(4000)
DECLARE @brand_id nvarchar(4000)
DECLARE @collaborator_ids nvarchar(4000)
DECLARE @created_at nvarchar(4000)
DECLARE @custom_fields nvarchar(4000)
DECLARE @custom_status_id nvarchar(4000)
DECLARE @description nvarchar(4000)
DECLARE @due_at nvarchar(4000)
DECLARE @email_cc_ids nvarchar(4000)
DECLARE @external_id nvarchar(4000)
DECLARE @follower_ids nvarchar(4000)
DECLARE @followup_ids nvarchar(4000)
DECLARE @forum_topic_id nvarchar(4000)
DECLARE @from_messaging_channel nvarchar(4000)
DECLARE @group_id nvarchar(4000)
DECLARE @has_incidents nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @is_public nvarchar(4000)
DECLARE @macro_id nvarchar(4000)
DECLARE @macro_ids nvarchar(4000)
DECLARE @organization_id nvarchar(4000)
DECLARE @priority nvarchar(4000)
DECLARE @problem_id nvarchar(4000)
DECLARE @raw_subject nvarchar(4000)
DECLARE @recipient nvarchar(4000)
DECLARE @safe_update nvarchar(4000)
DECLARE @Magnaae nvarchar(4000)
DECLARE @Nisi19 int
DECLARE @sharing_agreement_ids nvarchar(4000)
DECLARE @status nvarchar(4000)
DECLARE @subject nvarchar(4000)
DECLARE @submitter_id nvarchar(4000)
DECLARE @tags nvarchar(4000)
DECLARE @ticket_form_id nvarchar(4000)
DECLARE @v_type nvarchar(4000)
DECLARE @updated_at nvarchar(4000)
DECLARE @updated_stamp nvarchar(4000)
DECLARE @url nvarchar(4000)
DECLARE @Channel nvarchar(4000)
DECLARE @Veniam_79 nvarchar(4000)
DECLARE @via_followup_source_id nvarchar(4000)
DECLARE @via_id nvarchar(4000)
DECLARE @Eu_b int
DECLARE @Id2 nvarchar(4000)
DECLARE @Eiusmod_13 int
DECLARE @Occaecat1db nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @email nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'tickets'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @requester_id OUT, 'tickets[i].requester_id'
EXEC sp_OAMethod @jResp, 'StringOf', @allow_attachments OUT, 'tickets[i].allow_attachments'
EXEC sp_OAMethod @jResp, 'StringOf', @allow_channelback OUT, 'tickets[i].allow_channelback'
EXEC sp_OAMethod @jResp, 'StringOf', @assignee_email OUT, 'tickets[i].assignee_email'
EXEC sp_OAMethod @jResp, 'StringOf', @assignee_id OUT, 'tickets[i].assignee_id'
EXEC sp_OAMethod @jResp, 'StringOf', @attribute_value_ids OUT, 'tickets[i].attribute_value_ids'
EXEC sp_OAMethod @jResp, 'StringOf', @brand_id OUT, 'tickets[i].brand_id'
EXEC sp_OAMethod @jResp, 'StringOf', @collaborator_ids OUT, 'tickets[i].collaborator_ids'
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'tickets[i].created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @custom_fields OUT, 'tickets[i].custom_fields'
EXEC sp_OAMethod @jResp, 'StringOf', @custom_status_id OUT, 'tickets[i].custom_status_id'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'tickets[i].description'
EXEC sp_OAMethod @jResp, 'StringOf', @due_at OUT, 'tickets[i].due_at'
EXEC sp_OAMethod @jResp, 'StringOf', @email_cc_ids OUT, 'tickets[i].email_cc_ids'
EXEC sp_OAMethod @jResp, 'StringOf', @external_id OUT, 'tickets[i].external_id'
EXEC sp_OAMethod @jResp, 'StringOf', @follower_ids OUT, 'tickets[i].follower_ids'
EXEC sp_OAMethod @jResp, 'StringOf', @followup_ids OUT, 'tickets[i].followup_ids'
EXEC sp_OAMethod @jResp, 'StringOf', @forum_topic_id OUT, 'tickets[i].forum_topic_id'
EXEC sp_OAMethod @jResp, 'StringOf', @from_messaging_channel OUT, 'tickets[i].from_messaging_channel'
EXEC sp_OAMethod @jResp, 'StringOf', @group_id OUT, 'tickets[i].group_id'
EXEC sp_OAMethod @jResp, 'StringOf', @has_incidents OUT, 'tickets[i].has_incidents'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'tickets[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @is_public OUT, 'tickets[i].is_public'
EXEC sp_OAMethod @jResp, 'StringOf', @macro_id OUT, 'tickets[i].macro_id'
EXEC sp_OAMethod @jResp, 'StringOf', @macro_ids OUT, 'tickets[i].macro_ids'
EXEC sp_OAMethod @jResp, 'StringOf', @organization_id OUT, 'tickets[i].organization_id'
EXEC sp_OAMethod @jResp, 'StringOf', @priority OUT, 'tickets[i].priority'
EXEC sp_OAMethod @jResp, 'StringOf', @problem_id OUT, 'tickets[i].problem_id'
EXEC sp_OAMethod @jResp, 'StringOf', @raw_subject OUT, 'tickets[i].raw_subject'
EXEC sp_OAMethod @jResp, 'StringOf', @recipient OUT, 'tickets[i].recipient'
EXEC sp_OAMethod @jResp, 'StringOf', @safe_update OUT, 'tickets[i].safe_update'
EXEC sp_OAMethod @jResp, 'StringOf', @Magnaae OUT, 'tickets[i].satisfaction_rating.magnaae'
EXEC sp_OAMethod @jResp, 'BoolOf', @Nisi19 OUT, 'tickets[i].satisfaction_rating.nisi19'
EXEC sp_OAMethod @jResp, 'StringOf', @sharing_agreement_ids OUT, 'tickets[i].sharing_agreement_ids'
EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'tickets[i].status'
EXEC sp_OAMethod @jResp, 'StringOf', @subject OUT, 'tickets[i].subject'
EXEC sp_OAMethod @jResp, 'StringOf', @submitter_id OUT, 'tickets[i].submitter_id'
EXEC sp_OAMethod @jResp, 'StringOf', @tags OUT, 'tickets[i].tags'
EXEC sp_OAMethod @jResp, 'StringOf', @ticket_form_id OUT, 'tickets[i].ticket_form_id'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'tickets[i].type'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'tickets[i].updated_at'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_stamp OUT, 'tickets[i].updated_stamp'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'tickets[i].url'
EXEC sp_OAMethod @jResp, 'StringOf', @Channel OUT, 'tickets[i].via.channel'
EXEC sp_OAMethod @jResp, 'StringOf', @Veniam_79 OUT, 'tickets[i].via.source.veniam_79'
EXEC sp_OAMethod @jResp, 'StringOf', @via_followup_source_id OUT, 'tickets[i].via_followup_source_id'
EXEC sp_OAMethod @jResp, 'StringOf', @via_id OUT, 'tickets[i].via_id'
EXEC sp_OAMethod @jResp, 'IntOf', @Eu_b OUT, 'tickets[i].satisfaction_rating.eu_b'
EXEC sp_OAMethod @jResp, 'StringOf', @Id2 OUT, 'tickets[i].via.source.id2'
EXEC sp_OAMethod @jResp, 'IntOf', @Eiusmod_13 OUT, 'tickets[i].via.source.eiusmod_13'
EXEC sp_OAMethod @jResp, 'StringOf', @Occaecat1db OUT, 'tickets[i].via.source.occaecat1db'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'tickets[i].collaborators'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @email OUT, 'tickets[i].collaborators[j].email'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'tickets[i].collaborators[j].name'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
