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.

Using local fields in 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

Local field value formats

The format of a value in the body of a request to create or edit an issue depends on the field type and may differ from how the value is displayed and entered in the Tracker interface. The format of a value in an API response may also differ from the request format, so it is listed separately. Type class names for API requests are listed in the Request body parameters section of the request to create a local field.

If you specify a time in a Date value, it is ignored. For Date and time, you can pass "2026-11-01T12:30:00.000+03:00", for example.

Multiple values. For fields that allow multiple values (the container parameter when creating a field), pass an array of elements in the same format: ["user1", "user2"]. When editing an issue, you can use the set, add, and remove operators for such a field — learn more. The null value clears the field.

Drop-down list. Pass a value from the values list specified when creating the field. For a list with multiple choice, pass an array of such values.

Example request body with field types that aren't covered in the examples of creating and editing an issue:

{
    "603fb94c38bbe658********--durationField": "P1W2D",
    "603fb94c38bbe658********--moneyField": {"code": "USD", "amount": 12.34},
    "603fb94c38bbe658********--dateField": "2026-11-01",
    "603fb94c38bbe658********--dateTimeField": "2026-11-01T12:30:00.000+03:00"
}

Duration

Pass a string in ISO 8601 PnWnDTnHnMnS format: weeks (W), days (D), hours (H), minutes (M), and seconds (S). You can omit any part and combine weeks and days. For example, "P1W2D" or "PT1H30M".

Weeks and days are counted using the working calendar: a week is 5 working days, and a day is 8 hours. Years and months are not allowed. The API returns a string in the same format.

Money

In a request, you can pass:

• A number: an amount in the default currency, such as 12.34
• A string with a currency code and an amount: "USD 12.34"
• An object with the amount field and either the code field (ISO 4217 currency code) or the country field (country code)

The amount is rounded to the smallest unit of the currency: 12.3456 → 12.35 for USD.

Example request value:

{"code": "USD", "amount": 12.34}

In a response, the currency code is in the unit field, and the amount is a string:

{"unit": "USD", "amount": "12.34"}

Money and rate

Pass a number or an object with the same fields as the Money type plus the rate field. If you omit the rate, the default value is used. The amount is saved without rounding.

Example request value:

{"code": "USD", "amount": 12.34, "rate": 0.5}

In a response, the currency code is in the unit field, and amount and rate are strings:

{"unit": "USD", "amount": "12.34", "rate": "0.5"}