Issue parameters in API requests and responses

When working with issues via the API, you can use various parameters to create, edit, and get information about issues.

This documentation describes the standard issue parameters that are available in Tracker by default, as well as standard objects that can be included in an issue:

• Issue parameters in API requests
• Issue parameters in API responses

Besides standard parameters, issues can also contain:

• Custom global fields created in your organization.
• Local fields that are specific to a particular queue.

Global fields

You can use global fields in issues across all Tracker queues. By default, Tracker provides the most common issue fields.

Additional global fields can be created by your organization's administrator. How to add a global field to Tracker.

You can view the list of all global fields on the Tracker settings page.

Local fields

You can only use a local field in issues that belong to the queue it's attached to. The advantage of local fields is that the queue owner can manage them without affecting workflows in other queues. Users working in other queues won't see this field in their issues.

To learn how to use local fields, see Issue local fields.

Important considerations when working with local fields via the API:

• The ID of a local field includes a hexadecimal prefix and the field key: 603fb94c38bbe658********--myfield.

  For example, to change the value of an issue's local field via the API, in the HTTP request body for editing the issue, specify the field ID: 603fb94c38bbe658********--<field_key>: "<new_local_field_value>". How to edit an issue via the API

• Make sure the local field belongs to the specified queue.

• Follow the data types according to the field schema:

  • For string fields, use strings
  • For numeric fields, use numbers
  • For user arrays, use objects with the id field

• To get the list of queue local fields, use the request Get the list of queue local fields