Sign in
Ticket Forms

List Ticket Forms

Returns a list of all ticket forms for your account if accessed as an admin or agent. End users only see ticket forms that have end_user_visible set to true.

Allowed For

  • Anyone
get/api/v2/ticket_forms

Query parameters

activeboolean

true returns active ticket forms; false returns inactive ticket forms. If not present, returns both

end_user_visibleboolean

true returns ticket forms where end_user_visible; false returns ticket forms that are not end-user visible. If not present, returns both

fallback_to_defaultboolean

true returns the default ticket form when the criteria defined by the parameters results in a set without active and end-user visible ticket forms

associated_to_brandboolean

true returns the ticket forms of the brand specified by the url's subdomain

Response

Success response

Example response

{
  "ticket_forms": [
    {
      "active": true,
      "agent_conditions": [
        {
          "child_fields": [
            {
              "id": 101,
              "is_required": false,
              "required_on_statuses": {
                "statuses": [
                  "new",
                  "open",
                  "pending",
                  "hold"
                ],
                "type": "SOME_STATUSES"
              }
            },
            {
              "id": 200,
              "is_required": true,
              "required_on_statuses": {
                "statuses": [
                  "solved"
                ],
                "type": "SOME_STATUSES"
              }
            }
          ],
          "parent_field_id": 100,
          "value": "matching_value"
        },
        {
          "child_fields": [
            {
              "id": 102,
              "is_required": true,
              "required_on_statuses": {
                "type": "ALL_STATUSES"
              }
            },
            {
              "id": 200,
              "is_required": false,
              "required_on_statuses": {
                "type": "NO_STATUSES"
              }
            }
          ],
          "parent_field_id": 101,
          "value": "matching_value_2"
        }
      ],
      "created_at": "2012-04-02T22:55:29Z",
      "default": true,
      "deleted_at": "2012-05-02T22:55:29Z",
      "display_name": "Snowboard Damage",
      "end_user_conditions": [
        {
          "child_fields": [
            {
              "id": 101,
              "is_required": true
            }
          ],
          "parent_field_id": 100,
          "value": "matching_value"
        },
        {
          "child_fields": [
            {
              "id": 202,
              "is_required": false
            }
          ],
          "parent_field_id": 200,
          "value": "matching_value"
        }
      ],
      "end_user_visible": true,
      "id": 47,
      "in_all_brands": false,
      "name": "Snowboard Problem",
      "position": 9999,
      "raw_display_name": "{{dc.my_display_name}}",
      "raw_name": "Snowboard Problem",
      "restricted_brand_ids": [
        47,
        33,
        22
      ],
      "ticket_field_ids": [
        2,
        4,
        5,
        10,
        100,
        101,
        102,
        200
      ],
      "updated_at": "2012-04-02T22:55:29Z",
      "url": "https://company.zendesk.com/api/v2/ticket_forms/47.json"
    }
  ]
}

Changes