GET /api/v2/ticket_fields

Returns a list of all system and custom ticket fields in your account.

For end users, only the ticket fields with visible_in_portal set to true are returned.

Cursor pagination returns a maximum of 100 records per page and fields are returned in the order specified by their id.

If the results are not paginated, every field is returned in the response and fields are returned in the order specified by the position.

You can adjust the position of ticket fields by:

Using the Update Ticket Field endpoint
Using the Reorder Ticket Fields endpoint
Ticket Fields page in the Admin Center (Admin Center > Manage > Ticket > Fields > Actions > Edit order)

These adjustments determine the order in which fields are displayed in various locations. For accounts without access to multiple ticket forms, the order will also be used to display field values within tickets. However, for accounts with access to multiple ticket forms, the field order on the ticket page is defined within each form.

Consider caching this resource to use with the Tickets API.

Pagination

Cursor pagination (recommended)
No pagination

See Pagination.

Sideloads

The following sideloads are supported:

Name	Will sideload
users	The user or users that created the ticket field

Allowed For

Anyone

Servers

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

Query parameters

Name	Type	Required	Description
`locale`	String	No	Forces the `title_in_portal` property to return a dynamic content variant for the specified locale. Only accepts active locale ids. Example: `locale="de"`.
`creator`	Boolean	No	Displays the `creator_user_id` and `creator_app_name` properties. If the ticket field is created by an app, `creator_app_name` is the name of the app and `creator_user_id` is `-1`. If the ticket field is not created by an app, `creator_app_name` is null

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.

All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.

Pricing Templates Integrations Blog Contact Us Help

Terms of Service Privacy Policy