SQL Server / Support API / List Ticket Fields
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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'locale', '<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/ticket_fields', @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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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)
-- {
-- "ticket_fields": [
-- {
-- "type": "<string>",
-- "title": "<string>",
-- "active": "<boolean>",
-- "agent_description": "<string>",
-- "collapsed_for_agents": "<boolean>",
-- "created_at": "<dateTime>",
-- "custom_field_options": [
-- {
-- "name": "<string>",
-- "value": "<string>",
-- "id": "<integer>",
-- "position": "<integer>",
-- "raw_name": "<string>",
-- "url": "<string>"
-- },
-- {
-- "name": "<string>",
-- "value": "<string>",
-- "id": "<integer>",
-- "position": "<integer>",
-- "raw_name": "<string>",
-- "url": "<string>"
-- }
-- ],
-- "custom_statuses": [
-- {
-- "active": "<boolean>",
-- "agent_label": "<string>",
-- "created_at": "<dateTime>",
-- "default": "<boolean>",
-- "description": "<string>",
-- "end_user_description": "<string>",
-- "end_user_label": "<string>",
-- "id": "<integer>",
-- "status_category": "hold",
-- "updated_at": "<dateTime>"
-- },
-- {
-- "active": "<boolean>",
-- "agent_label": "<string>",
-- "created_at": "<dateTime>",
-- "default": "<boolean>",
-- "description": "<string>",
-- "end_user_description": "<string>",
-- "end_user_label": "<string>",
-- "id": "<integer>",
-- "status_category": "pending",
-- "updated_at": "<dateTime>"
-- }
-- ],
-- "description": "<string>",
-- "editable_in_portal": "<boolean>",
-- "id": "<integer>",
-- "position": "<integer>",
-- "raw_description": "<string>",
-- "raw_title": "<string>",
-- "raw_title_in_portal": "<string>",
-- "regexp_for_validation": "<string>",
-- "relationship_filter": {},
-- "relationship_target_type": "<string>",
-- "removable": "<boolean>",
-- "required": "<boolean>",
-- "required_in_portal": "<boolean>",
-- "sub_type_id": "<integer>",
-- "system_field_options": [
-- {
-- "name": "<string>",
-- "value": "<string>"
-- },
-- {
-- "name": "<string>",
-- "value": "<string>"
-- }
-- ],
-- "tag": "<string>",
-- "title_in_portal": "<string>",
-- "updated_at": "<dateTime>",
-- "url": "<string>",
-- "visible_in_portal": "<boolean>"
-- },
-- {
-- "type": "<string>",
-- "title": "<string>",
-- "active": "<boolean>",
-- "agent_description": "<string>",
-- "collapsed_for_agents": "<boolean>",
-- "created_at": "<dateTime>",
-- "custom_field_options": [
-- {
-- "name": "<string>",
-- "value": "<string>",
-- "id": "<integer>",
-- "position": "<integer>",
-- "raw_name": "<string>",
-- "url": "<string>"
-- },
-- {
-- "name": "<string>",
-- "value": "<string>",
-- "id": "<integer>",
-- "position": "<integer>",
-- "raw_name": "<string>",
-- "url": "<string>"
-- }
-- ],
-- "custom_statuses": [
-- {
-- "active": "<boolean>",
-- "agent_label": "<string>",
-- "created_at": "<dateTime>",
-- "default": "<boolean>",
-- "description": "<string>",
-- "end_user_description": "<string>",
-- "end_user_label": "<string>",
-- "id": "<integer>",
-- "status_category": "pending",
-- "updated_at": "<dateTime>"
-- },
-- {
-- "active": "<boolean>",
-- "agent_label": "<string>",
-- "created_at": "<dateTime>",
-- "default": "<boolean>",
-- "description": "<string>",
-- "end_user_description": "<string>",
-- "end_user_label": "<string>",
-- "id": "<integer>",
-- "status_category": "new",
-- "updated_at": "<dateTime>"
-- }
-- ],
-- "description": "<string>",
-- "editable_in_portal": "<boolean>",
-- "id": "<integer>",
-- "position": "<integer>",
-- "raw_description": "<string>",
-- "raw_title": "<string>",
-- "raw_title_in_portal": "<string>",
-- "regexp_for_validation": "<string>",
-- "relationship_filter": {},
-- "relationship_target_type": "<string>",
-- "removable": "<boolean>",
-- "required": "<boolean>",
-- "required_in_portal": "<boolean>",
-- "sub_type_id": "<integer>",
-- "system_field_options": [
-- {
-- "name": "<string>",
-- "value": "<string>"
-- },
-- {
-- "name": "<string>",
-- "value": "<string>"
-- }
-- ],
-- "tag": "<string>",
-- "title_in_portal": "<string>",
-- "updated_at": "<dateTime>",
-- "url": "<string>",
-- "visible_in_portal": "<boolean>"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @v_type nvarchar(4000)
DECLARE @title nvarchar(4000)
DECLARE @active nvarchar(4000)
DECLARE @agent_description nvarchar(4000)
DECLARE @collapsed_for_agents nvarchar(4000)
DECLARE @created_at nvarchar(4000)
DECLARE @description nvarchar(4000)
DECLARE @editable_in_portal nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @position nvarchar(4000)
DECLARE @raw_description nvarchar(4000)
DECLARE @raw_title nvarchar(4000)
DECLARE @raw_title_in_portal nvarchar(4000)
DECLARE @regexp_for_validation nvarchar(4000)
DECLARE @relationship_target_type nvarchar(4000)
DECLARE @removable nvarchar(4000)
DECLARE @required nvarchar(4000)
DECLARE @required_in_portal nvarchar(4000)
DECLARE @sub_type_id nvarchar(4000)
DECLARE @tag nvarchar(4000)
DECLARE @title_in_portal nvarchar(4000)
DECLARE @updated_at nvarchar(4000)
DECLARE @url nvarchar(4000)
DECLARE @visible_in_portal nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @name nvarchar(4000)
DECLARE @value nvarchar(4000)
DECLARE @raw_name nvarchar(4000)
DECLARE @agent_label nvarchar(4000)
DECLARE @default nvarchar(4000)
DECLARE @end_user_description nvarchar(4000)
DECLARE @end_user_label nvarchar(4000)
DECLARE @status_category nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'ticket_fields'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'ticket_fields[i].type'
EXEC sp_OAMethod @jResp, 'StringOf', @title OUT, 'ticket_fields[i].title'
EXEC sp_OAMethod @jResp, 'StringOf', @active OUT, 'ticket_fields[i].active'
EXEC sp_OAMethod @jResp, 'StringOf', @agent_description OUT, 'ticket_fields[i].agent_description'
EXEC sp_OAMethod @jResp, 'StringOf', @collapsed_for_agents OUT, 'ticket_fields[i].collapsed_for_agents'
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'ticket_fields[i].created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'ticket_fields[i].description'
EXEC sp_OAMethod @jResp, 'StringOf', @editable_in_portal OUT, 'ticket_fields[i].editable_in_portal'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'ticket_fields[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @position OUT, 'ticket_fields[i].position'
EXEC sp_OAMethod @jResp, 'StringOf', @raw_description OUT, 'ticket_fields[i].raw_description'
EXEC sp_OAMethod @jResp, 'StringOf', @raw_title OUT, 'ticket_fields[i].raw_title'
EXEC sp_OAMethod @jResp, 'StringOf', @raw_title_in_portal OUT, 'ticket_fields[i].raw_title_in_portal'
EXEC sp_OAMethod @jResp, 'StringOf', @regexp_for_validation OUT, 'ticket_fields[i].regexp_for_validation'
EXEC sp_OAMethod @jResp, 'StringOf', @relationship_target_type OUT, 'ticket_fields[i].relationship_target_type'
EXEC sp_OAMethod @jResp, 'StringOf', @removable OUT, 'ticket_fields[i].removable'
EXEC sp_OAMethod @jResp, 'StringOf', @required OUT, 'ticket_fields[i].required'
EXEC sp_OAMethod @jResp, 'StringOf', @required_in_portal OUT, 'ticket_fields[i].required_in_portal'
EXEC sp_OAMethod @jResp, 'StringOf', @sub_type_id OUT, 'ticket_fields[i].sub_type_id'
EXEC sp_OAMethod @jResp, 'StringOf', @tag OUT, 'ticket_fields[i].tag'
EXEC sp_OAMethod @jResp, 'StringOf', @title_in_portal OUT, 'ticket_fields[i].title_in_portal'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'ticket_fields[i].updated_at'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'ticket_fields[i].url'
EXEC sp_OAMethod @jResp, 'StringOf', @visible_in_portal OUT, 'ticket_fields[i].visible_in_portal'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'ticket_fields[i].custom_field_options'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'ticket_fields[i].custom_field_options[j].name'
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'ticket_fields[i].custom_field_options[j].value'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'ticket_fields[i].custom_field_options[j].id'
EXEC sp_OAMethod @jResp, 'StringOf', @position OUT, 'ticket_fields[i].custom_field_options[j].position'
EXEC sp_OAMethod @jResp, 'StringOf', @raw_name OUT, 'ticket_fields[i].custom_field_options[j].raw_name'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'ticket_fields[i].custom_field_options[j].url'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'ticket_fields[i].custom_statuses'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @active OUT, 'ticket_fields[i].custom_statuses[j].active'
EXEC sp_OAMethod @jResp, 'StringOf', @agent_label OUT, 'ticket_fields[i].custom_statuses[j].agent_label'
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'ticket_fields[i].custom_statuses[j].created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @default OUT, 'ticket_fields[i].custom_statuses[j].default'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'ticket_fields[i].custom_statuses[j].description'
EXEC sp_OAMethod @jResp, 'StringOf', @end_user_description OUT, 'ticket_fields[i].custom_statuses[j].end_user_description'
EXEC sp_OAMethod @jResp, 'StringOf', @end_user_label OUT, 'ticket_fields[i].custom_statuses[j].end_user_label'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'ticket_fields[i].custom_statuses[j].id'
EXEC sp_OAMethod @jResp, 'StringOf', @status_category OUT, 'ticket_fields[i].custom_statuses[j].status_category'
EXEC sp_OAMethod @jResp, 'StringOf', @updated_at OUT, 'ticket_fields[i].custom_statuses[j].updated_at'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'ticket_fields[i].system_field_options'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'ticket_fields[i].system_field_options[j].name'
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'ticket_fields[i].system_field_options[j].value'
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 "locale=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/ticket_fields
Postman Collection Item JSON
{
"name": "List Ticket Fields",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ticket_fields?locale=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ticket_fields"
],
"query": [
{
"key": "locale",
"value": "<string>",
"description": "Forces the `title_in_portal` property to return a dynamic content variant for the specified locale.\n Only accepts [active locale ids](/api-reference/ticketing/account-configuration/locales/#list-locales).\nExample: `locale=\"de\"`.\n"
}
]
},
"description": "Returns a list of all system and custom ticket fields in your account.\n\nCursor pagination returns a maximum of 100 records per page and fields are returned in the order specified by their id.\n\nIf the results are not paginated every field is returned in the response and fields are returned in the order specified by the position and id.\n\nFor accounts without access to multiple ticket forms, positions can be changed using the [Update Ticket Field](/api-reference/ticketing/tickets/ticket_fields/#update-ticket-field) endpoint or the Ticket Forms page in Zendesk Support (**Admin** > **Manage** > **Ticket Forms**). The Ticket Forms page shows the fields for the account. The order of the fields is used in the different products to show the field values in the tickets.\n\nFor accounts with access to multiple ticket forms, positions can only be changed using the [Update Ticket Field](/api-reference/ticketing/tickets/ticket_fields/#update-ticket-field) endpoint because products use the order defined on each form to show the field values instead of the general position of the ticket field in the account.\n\nConsider caching this resource to use with the [Tickets](/api-reference/ticketing/tickets/tickets/#json-format) API.\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- No pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\n#### Allowed For\n\n* Agents\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/ticket_fields?locale=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ticket_fields"
],
"query": [
{
"key": "locale",
"value": "<string>",
"description": "Forces the `title_in_portal` property to return a dynamic content variant for the specified locale.\n Only accepts [active locale ids](/api-reference/ticketing/account-configuration/locales/#list-locales).\nExample: `locale=\"de\"`.\n"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"ticket_fields\": [\n {\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"agent_description\": \"<string>\",\n \"collapsed_for_agents\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"custom_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"custom_statuses\": [\n {\n \"active\": \"<boolean>\",\n \"agent_label\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"end_user_description\": \"<string>\",\n \"end_user_label\": \"<string>\",\n \"id\": \"<integer>\",\n \"status_category\": \"hold\",\n \"updated_at\": \"<dateTime>\"\n },\n {\n \"active\": \"<boolean>\",\n \"agent_label\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"end_user_description\": \"<string>\",\n \"end_user_label\": \"<string>\",\n \"id\": \"<integer>\",\n \"status_category\": \"pending\",\n \"updated_at\": \"<dateTime>\"\n }\n ],\n \"description\": \"<string>\",\n \"editable_in_portal\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_description\": \"<string>\",\n \"raw_title\": \"<string>\",\n \"raw_title_in_portal\": \"<string>\",\n \"regexp_for_validation\": \"<string>\",\n \"relationship_filter\": {},\n \"relationship_target_type\": \"<string>\",\n \"removable\": \"<boolean>\",\n \"required\": \"<boolean>\",\n \"required_in_portal\": \"<boolean>\",\n \"sub_type_id\": \"<integer>\",\n \"system_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"tag\": \"<string>\",\n \"title_in_portal\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"visible_in_portal\": \"<boolean>\"\n },\n {\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"agent_description\": \"<string>\",\n \"collapsed_for_agents\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"custom_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"custom_statuses\": [\n {\n \"active\": \"<boolean>\",\n \"agent_label\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"end_user_description\": \"<string>\",\n \"end_user_label\": \"<string>\",\n \"id\": \"<integer>\",\n \"status_category\": \"pending\",\n \"updated_at\": \"<dateTime>\"\n },\n {\n \"active\": \"<boolean>\",\n \"agent_label\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"end_user_description\": \"<string>\",\n \"end_user_label\": \"<string>\",\n \"id\": \"<integer>\",\n \"status_category\": \"new\",\n \"updated_at\": \"<dateTime>\"\n }\n ],\n \"description\": \"<string>\",\n \"editable_in_portal\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_description\": \"<string>\",\n \"raw_title\": \"<string>\",\n \"raw_title_in_portal\": \"<string>\",\n \"regexp_for_validation\": \"<string>\",\n \"relationship_filter\": {},\n \"relationship_target_type\": \"<string>\",\n \"removable\": \"<boolean>\",\n \"required\": \"<boolean>\",\n \"required_in_portal\": \"<boolean>\",\n \"sub_type_id\": \"<integer>\",\n \"system_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"tag\": \"<string>\",\n \"title_in_portal\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"visible_in_portal\": \"<boolean>\"\n }\n ]\n}"
}
]
}
