Qodex.ai

List ticket templates

GET {{baseUrl}}/v1/ticketTemplates

This API lists a particular number of ticket templates, based on the limit specified.

OAuth Scope

  • Desk.settings.READ

Request Params

KeyDatatypeRequiredDescription
fromstringIndex number, starting from which the templates must be fetched
departmentIdstringID of the department from which templates must be fetched
layoutIdstringID of the layout from which templated must be fetched for the given department ID
limitstringNumber of templates to list. The default value is 10 and the maximum value supported is 100
showInCustomerPortalstringVisibility of the templates in the help center
templateNamestringName of the template
searchStrstringString to search for ticket templates by ticket template name

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"showInCustomerPortal":true,"ticketTemplateName":"Template1","id":"4000000020001","layoutId":"4000000020121"},{"showInCustomerPortal":false,"ticketTemplateName":"Template2","id":"4000000020063","layoutId":"4000000020431"}]}