GET /api/v2/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

Servers

https://{subdomain}.{domain}.com

Query parameters

Name	Type	Required	Description
`end_user_visible`	Boolean	No	true returns ticket forms where `end_user_visible`; false returns ticket forms that are not end-user visible. If not present, returns both
`page`		No	Pagination parameter. Supports both traditional offset and cursor-based pagination: Traditional: `?page=2` (integer page number) Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.
`include_boundary_indicators`	Boolean	No	When true, includes `has_more` indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]).
`active`	Boolean	No	true returns active ticket forms; false returns inactive ticket forms. If not present, returns both
`form_type`	String	No	Filter ticket forms by type. Use 'standard' for regular ticket forms, 'service_catalog' for service catalog forms, or 'all' to return all form types Valid values: `"standard"` `"service_catalog"` `"all"`
`per_page`	Integer	No	Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.
`sort`	String	No	Field to sort results by. Prefix with `-` for descending order. When used with cursor pagination, this determines the cursor ordering. Example: `?sort=name` or `?sort=-created_at`
`locale`	String	No	Locale to use for the ticket form names. If not specified, the default locale is used.
`fallback_to_default`	Boolean	No	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
`include_item_cursors`	Boolean	No	When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]).
`associated_to_brand`	Boolean	No	true returns the ticket forms of the brand specified by the url's subdomain

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.