The Scenario
A Zendesk consultant was hired to document a client's complete ticket schema before a major integration build. The integration team needs every custom field — API name, type, dropdown options — specified in an Excel workbook before they can write a single line of mapping code. The client has 35 custom ticket fields. The consultant's first working session is Wednesday morning.
She opened Zendesk Admin on Tuesday evening to get a head start and clicked into the first custom field. Then the second. By the third she understood that doing this for 35 fields — including all the dropdown option values — was going to take the majority of Wednesday's session time she'd planned to spend on the actual integration design.
The bad version:
- Click through each custom field in Zendesk Admin.
- Note the API name, display name, field type, required status.
- For dropdown fields, open the options panel and copy each value.
- At field 12, find a dropdown with 80 options and realize that manually documenting this one field is going to take 20 minutes.
Schema documentation is foundational. If the integration team gets the API names wrong, everything built on top of them breaks. Accuracy matters, and the manual approach introduces copy errors at the exact layer where copy errors are most costly.
The Easy Way: One Prompt in SheetXAI
SheetXAI is an AI agent inside your Excel workbook. It uses the Zendesk integration to pull every field definition in one accurate pull.
Open the SheetXAI sidebar in the integration spec workbook and paste:
Export all custom Zendesk ticket fields into this Excel sheet — populate field ID, display title, field type, and all available dropdown options for each custom field
What You Get
- One row per custom ticket field.
- Field ID, display title, field type, and all dropdown options in the columns you named.
- System fields excluded — only custom fields returned.
35 fields documented, including every dropdown value, without clicking through a single field page.
What If the Data Is Not Quite Ready
You need the API name alongside the display title
Export all custom Zendesk ticket fields — field ID, display title, API name, field type, required status, and all dropdown options — to this Excel sheet
API name column included for the integration mapping spec.
You want each dropdown option on its own row
Export all custom Zendesk ticket fields to this Excel sheet — for simple fields (text, checkbox), one row per field with field ID, API name, title, and type. For dropdown and multi-select fields, one row per option with field ID, API name, and option value
One row per option for the fields that need it.
You want required fields highlighted separately
Export all Zendesk ticket fields — field ID, API name, display title, field type, required status, options. Put required fields in the 'Required' worksheet and optional fields in the 'Optional' worksheet
Two-worksheet split for the integration build review.
Full integration spec package
Export all Zendesk ticket fields to the 'Field Schema' worksheet — field ID, API name, display title, field type, required status, and all dropdown options. On the 'Summary' worksheet, write the total field count and a breakdown by field type
Complete schema with type distribution — one prompt, integration spec ready for the Wednesday session.
Try It
Get the 7-day free trial of SheetXAI and open your integration spec workbook, then export the field schema. Related: export triggers to document the automation rules that reference these fields, or return to the Zendesk integration guide.