Ticket Fields

Ticket fields consist of standard fields that came with your Zendesk, such as Subject and Description, or custom fields that you have defined in the Ticket Fields configuration of your Zendesk.

LIST ALL

GET /ticket_fields.xml
Returns a list of all ticket fields in your Zendesk. Fields are returned in the order that you specify in your Ticket Fields configuration in Zendesk. Clients should cache this resource for the duration of their API usage and map the value of id for each ticket field to the values returned under the ticket_field_entries attributes on the Tickets resource.

Response

Status: 200

<records type="array" count="14">
  <record>
    <account-id type="integer">17721</account-id>
    <created-at type="datetime">2009-10-18T20:56:52-07:00</created-at>
    <default-value nil="true"></default-value>
    <description>Please enter the details of your request. A member of our support staff will respond as soon as possible.</description>
    <id type="integer">120913</id>
    <is-active type="boolean">true</is-active>
    <is-editable-in-portal type="boolean">true</is-editable-in-portal>
    <is-required type="boolean">false</is-required>
    <is-required-in-portal type="boolean">true</is-required-in-portal>
    <is-visible-in-portal type="boolean">true</is-visible-in-portal>
    <position type="integer">0</position>
    <regexp-for-validation nil="true"></regexp-for-validation>
    <sub-type-id type="integer" nil="true"></sub-type-id>
    <title>Description</title>
    <title-in-portal>Description</title-in-portal>
    <type>FieldDescription</type>
    <updated-at type="datetime">2010-07-09T15:04:37-07:00</updated-at>
  </record>
  <record>
    <account-id type="integer">17721</account-id>
    <created-at type="datetime">2009-10-18T20:56:52-07:00</created-at>
    <default-value nil="true"></default-value>
    <description></description>
    <id type="integer">120912</id>
    <is-active type="boolean">true</is-active>
    <is-editable-in-portal type="boolean">true</is-editable-in-portal>
    <is-required type="boolean">false</is-required>
    <is-required-in-portal type="boolean">true</is-required-in-portal>
    <is-visible-in-portal type="boolean">true</is-visible-in-portal>
    <position type="integer">1</position>
    <regexp-for-validation nil="true"></regexp-for-validation>
    <sub-type-id type="integer" nil="true"></sub-type-id>
    <title>Subject</title>
    <title-in-portal>Subject</title-in-portal>
    <type>FieldSubject</type>
    <updated-at type="datetime">2010-06-24T22:23:18-07:00</updated-at>
  </record>
  ...
  <record>
    <account-id type="integer">17721</account-id>
    <created-at type="datetime">2010-04-15T11:41:50-07:00</created-at>
    <default-value nil="true"></default-value>
    <description></description>
    <id type="integer">224471</id>
    <is-active type="boolean">true</is-active>
    <is-editable-in-portal type="boolean">false</is-editable-in-portal>
    <is-required type="boolean">false</is-required>
    <is-required-in-portal type="boolean">false</is-required-in-portal>
    <is-visible-in-portal type="boolean">false</is-visible-in-portal>
    <position type="integer">13</position>
    <regexp-for-validation>[a-z]</regexp-for-validation>
    <sub-type-id type="integer" nil="true"></sub-type-id>
    <title>Custom Regex Field</title>
    <title-in-portal>Custom Regex Field</title-in-portal>
    <type>FieldRegexp</type>
    <updated-at type="datetime">2010-07-09T15:04:37-07:00</updated-at>
  </record>
</records>