Chilkat Online Tools

Mono / Support API / List Ticket Fields

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Chilkat.Http http = new Chilkat.Http();
bool success;

http.BasicAuth = true;
http.Login = "login";
http.Password = "password";

Chilkat.JsonObject queryParams = new Chilkat.JsonObject();
queryParams.UpdateString("locale","<string>");

http.SetRequestHeader("Accept","application/json");

Chilkat.HttpResponse resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/ticket_fields",queryParams);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

// 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

string v_type;
string title;
string active;
string agent_description;
string collapsed_for_agents;
string created_at;
string description;
string editable_in_portal;
string id;
string position;
string raw_description;
string raw_title;
string raw_title_in_portal;
string regexp_for_validation;
string relationship_target_type;
string removable;
string required;
string required_in_portal;
string sub_type_id;
string tag;
string title_in_portal;
string updated_at;
string url;
string visible_in_portal;
int j;
int count_j;
string name;
string value;
string raw_name;
string agent_label;
string default;
string end_user_description;
string end_user_label;
string status_category;

int i = 0;
int count_i = jResp.SizeOfArray("ticket_fields");
while (i < count_i) {
    jResp.I = i;
    v_type = jResp.StringOf("ticket_fields[i].type");
    title = jResp.StringOf("ticket_fields[i].title");
    active = jResp.StringOf("ticket_fields[i].active");
    agent_description = jResp.StringOf("ticket_fields[i].agent_description");
    collapsed_for_agents = jResp.StringOf("ticket_fields[i].collapsed_for_agents");
    created_at = jResp.StringOf("ticket_fields[i].created_at");
    description = jResp.StringOf("ticket_fields[i].description");
    editable_in_portal = jResp.StringOf("ticket_fields[i].editable_in_portal");
    id = jResp.StringOf("ticket_fields[i].id");
    position = jResp.StringOf("ticket_fields[i].position");
    raw_description = jResp.StringOf("ticket_fields[i].raw_description");
    raw_title = jResp.StringOf("ticket_fields[i].raw_title");
    raw_title_in_portal = jResp.StringOf("ticket_fields[i].raw_title_in_portal");
    regexp_for_validation = jResp.StringOf("ticket_fields[i].regexp_for_validation");
    relationship_target_type = jResp.StringOf("ticket_fields[i].relationship_target_type");
    removable = jResp.StringOf("ticket_fields[i].removable");
    required = jResp.StringOf("ticket_fields[i].required");
    required_in_portal = jResp.StringOf("ticket_fields[i].required_in_portal");
    sub_type_id = jResp.StringOf("ticket_fields[i].sub_type_id");
    tag = jResp.StringOf("ticket_fields[i].tag");
    title_in_portal = jResp.StringOf("ticket_fields[i].title_in_portal");
    updated_at = jResp.StringOf("ticket_fields[i].updated_at");
    url = jResp.StringOf("ticket_fields[i].url");
    visible_in_portal = jResp.StringOf("ticket_fields[i].visible_in_portal");
    j = 0;
    count_j = jResp.SizeOfArray("ticket_fields[i].custom_field_options");
    while (j < count_j) {
        jResp.J = j;
        name = jResp.StringOf("ticket_fields[i].custom_field_options[j].name");
        value = jResp.StringOf("ticket_fields[i].custom_field_options[j].value");
        id = jResp.StringOf("ticket_fields[i].custom_field_options[j].id");
        position = jResp.StringOf("ticket_fields[i].custom_field_options[j].position");
        raw_name = jResp.StringOf("ticket_fields[i].custom_field_options[j].raw_name");
        url = jResp.StringOf("ticket_fields[i].custom_field_options[j].url");
        j = j + 1;
    }

    j = 0;
    count_j = jResp.SizeOfArray("ticket_fields[i].custom_statuses");
    while (j < count_j) {
        jResp.J = j;
        active = jResp.StringOf("ticket_fields[i].custom_statuses[j].active");
        agent_label = jResp.StringOf("ticket_fields[i].custom_statuses[j].agent_label");
        created_at = jResp.StringOf("ticket_fields[i].custom_statuses[j].created_at");
        default = jResp.StringOf("ticket_fields[i].custom_statuses[j].default");
        description = jResp.StringOf("ticket_fields[i].custom_statuses[j].description");
        end_user_description = jResp.StringOf("ticket_fields[i].custom_statuses[j].end_user_description");
        end_user_label = jResp.StringOf("ticket_fields[i].custom_statuses[j].end_user_label");
        id = jResp.StringOf("ticket_fields[i].custom_statuses[j].id");
        status_category = jResp.StringOf("ticket_fields[i].custom_statuses[j].status_category");
        updated_at = jResp.StringOf("ticket_fields[i].custom_statuses[j].updated_at");
        j = j + 1;
    }

    j = 0;
    count_j = jResp.SizeOfArray("ticket_fields[i].system_field_options");
    while (j < count_j) {
        jResp.J = j;
        name = jResp.StringOf("ticket_fields[i].system_field_options[j].name");
        value = jResp.StringOf("ticket_fields[i].system_field_options[j].value");
        j = j + 1;
    }

    i = i + 1;
}

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}"
    }
  ]
}