Foxpro / Support API / List Ticket Fields
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcV_type
LOCAL lcTitle
LOCAL lcActive
LOCAL lcAgent_description
LOCAL lcCollapsed_for_agents
LOCAL lcCreated_at
LOCAL lcDescription
LOCAL lcEditable_in_portal
LOCAL lcId
LOCAL lcPosition
LOCAL lcRaw_description
LOCAL lcRaw_title
LOCAL lcRaw_title_in_portal
LOCAL lcRegexp_for_validation
LOCAL lcRelationship_target_type
LOCAL lcRemovable
LOCAL lcRequired
LOCAL lcRequired_in_portal
LOCAL lcSub_type_id
LOCAL lcTag
LOCAL lcTitle_in_portal
LOCAL lcUpdated_at
LOCAL lcUrl
LOCAL lcVisible_in_portal
LOCAL j
LOCAL lnCount_j
LOCAL lcName
LOCAL lcValue
LOCAL lcRaw_name
LOCAL lcAgent_label
LOCAL lcDefault
LOCAL lcEnd_user_description
LOCAL lcEnd_user_label
LOCAL lcStatus_category
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("locale","<string>")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://example.zendesk.com/api/v2/ticket_fields",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
i = 0
lnCount_i = loJResp.SizeOfArray("ticket_fields")
DO WHILE i < lnCount_i
loJResp.I = i
lcV_type = loJResp.StringOf("ticket_fields[i].type")
lcTitle = loJResp.StringOf("ticket_fields[i].title")
lcActive = loJResp.StringOf("ticket_fields[i].active")
lcAgent_description = loJResp.StringOf("ticket_fields[i].agent_description")
lcCollapsed_for_agents = loJResp.StringOf("ticket_fields[i].collapsed_for_agents")
lcCreated_at = loJResp.StringOf("ticket_fields[i].created_at")
lcDescription = loJResp.StringOf("ticket_fields[i].description")
lcEditable_in_portal = loJResp.StringOf("ticket_fields[i].editable_in_portal")
lcId = loJResp.StringOf("ticket_fields[i].id")
lcPosition = loJResp.StringOf("ticket_fields[i].position")
lcRaw_description = loJResp.StringOf("ticket_fields[i].raw_description")
lcRaw_title = loJResp.StringOf("ticket_fields[i].raw_title")
lcRaw_title_in_portal = loJResp.StringOf("ticket_fields[i].raw_title_in_portal")
lcRegexp_for_validation = loJResp.StringOf("ticket_fields[i].regexp_for_validation")
lcRelationship_target_type = loJResp.StringOf("ticket_fields[i].relationship_target_type")
lcRemovable = loJResp.StringOf("ticket_fields[i].removable")
lcRequired = loJResp.StringOf("ticket_fields[i].required")
lcRequired_in_portal = loJResp.StringOf("ticket_fields[i].required_in_portal")
lcSub_type_id = loJResp.StringOf("ticket_fields[i].sub_type_id")
lcTag = loJResp.StringOf("ticket_fields[i].tag")
lcTitle_in_portal = loJResp.StringOf("ticket_fields[i].title_in_portal")
lcUpdated_at = loJResp.StringOf("ticket_fields[i].updated_at")
lcUrl = loJResp.StringOf("ticket_fields[i].url")
lcVisible_in_portal = loJResp.StringOf("ticket_fields[i].visible_in_portal")
j = 0
lnCount_j = loJResp.SizeOfArray("ticket_fields[i].custom_field_options")
DO WHILE j < lnCount_j
loJResp.J = j
lcName = loJResp.StringOf("ticket_fields[i].custom_field_options[j].name")
lcValue = loJResp.StringOf("ticket_fields[i].custom_field_options[j].value")
lcId = loJResp.StringOf("ticket_fields[i].custom_field_options[j].id")
lcPosition = loJResp.StringOf("ticket_fields[i].custom_field_options[j].position")
lcRaw_name = loJResp.StringOf("ticket_fields[i].custom_field_options[j].raw_name")
lcUrl = loJResp.StringOf("ticket_fields[i].custom_field_options[j].url")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("ticket_fields[i].custom_statuses")
DO WHILE j < lnCount_j
loJResp.J = j
lcActive = loJResp.StringOf("ticket_fields[i].custom_statuses[j].active")
lcAgent_label = loJResp.StringOf("ticket_fields[i].custom_statuses[j].agent_label")
lcCreated_at = loJResp.StringOf("ticket_fields[i].custom_statuses[j].created_at")
lcDefault = loJResp.StringOf("ticket_fields[i].custom_statuses[j].default")
lcDescription = loJResp.StringOf("ticket_fields[i].custom_statuses[j].description")
lcEnd_user_description = loJResp.StringOf("ticket_fields[i].custom_statuses[j].end_user_description")
lcEnd_user_label = loJResp.StringOf("ticket_fields[i].custom_statuses[j].end_user_label")
lcId = loJResp.StringOf("ticket_fields[i].custom_statuses[j].id")
lcStatus_category = loJResp.StringOf("ticket_fields[i].custom_statuses[j].status_category")
lcUpdated_at = loJResp.StringOf("ticket_fields[i].custom_statuses[j].updated_at")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("ticket_fields[i].system_field_options")
DO WHILE j < lnCount_j
loJResp.J = j
lcName = loJResp.StringOf("ticket_fields[i].system_field_options[j].name")
lcValue = loJResp.StringOf("ticket_fields[i].system_field_options[j].value")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
