Question
How do I find the ID of a ticket form?
Answer
-
Enterprise plan or Professional plus Productivity Pack add-on
The ticket form ID can be found in the url of the ticket form. Click the Admin icon (
) in the sidebar, then select Manage > Ticket Forms. At this point you can view the ID for any form by selecting the form in question, then viewing the URL at the top of the page. The ticket form ID will be displayed at the end of the URL.
For more information on ticket forms, see Creating ticket forms to support multiple request types (Professional Add-on and Enterprise).
-
Essential, Team and Professional plans
You can retrieve the ticket form ID by using the List Tickets API end-point or by using the Ticket Audits end-point and searching for the value of the Ticket_Form_ID creation event.
9 Comments
Why not list the form ID in the list of forms?
Hey Heather!
The most likely scenario is that we didn't build it that way to start with, and changing it hasn't registered high enough on the to-do list for UI improvements. It would definitely make sense to do it that way, though. I don't see any posts about it in Product Feedback, but you can definitely start a new thread over there if you'd like!
Help!
This is frustrating, if anyone who can help sees this respond in kind. Thanks
Hi Margaret,
I think you can go to your browser and type in:
https://ENTERYOURDOMAINHERE.zendesk.com/api/v2/ticket_forms.json
Then search for the raw name and you should be able to find the form ID number in the jumble of stuff on your screen hopefully!!
Hi,
Unfortunately I can't see Ticket_Form_ID in List tickets API response
Is this field still active ?
Thanks
Hey Jonathan,
If you're just looking to list the Ticket Forms to capture the ID you can actually use the ticket forms endpoint which I've linked for you.
By adding /api/v2/ticket_forms.json to your subdomain that should list all forms and their ID.
Let me know if you run into any issues!
Hi Brent ,
I’m getting an error when doing that
"error": {
"title": "Unauthorized",
"message": "You must supply credentials to complete this request"
}
}
Please note I'm on essential plan
Hey Jonathan,
You should still have access to the API regardless of what plan level you're on. However, if you're on Essential you would only have access to one Ticket Form.
You can also try running the API call using our API Console which I've linked for you.
The error you're seeing could be related to plan level since you don't have access to multiple forms.
Let us know if you have any other questions!
Please sign in to leave a comment.