Help Center/ CodeArts Req/ API Reference/ API/ Work Items of a Scrum Project/ Querying Custom Field Values
Updated on 2026-10-27 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Custom Field Values

Function

This API is used to query custom field values.

Calling Method

For details, see Calling APIs.

Authorization Information

No identity policy-based permission required for calling this API.

URI

GET /v2/custom-field/query-custom-field

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

project_id

No

String

Definition

A 32-character UUID. It uniquely identifies a project. Obtain a project ID by calling the API for querying projects. The value of project_id in the response message body is a project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

tracker_id

No

String

Definition:

Work item type.

Constraints:

N/A

Value range:

2 (task)

3 (bug)

5 (epic)

6 (feature)

7 (story)

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

result

result object

Definition:

Response result of querying the value of a custom field.

status

String

Definition:

Status of the response body for querying custom fields.

Value range:

success: successful

error: failed
Table 3 result

Parameter

Type

Description

custom_field

Array of custom_field objects

Definition:

List of custom fields.
Table 4 custom_field

Parameter

Type

Description

tracker_list

Array of strings

Definition:

List of custom fields.

Value range:

N/A

region

String

Definition:

Region of the project.

Value range:

N/A

id

Integer

Definition

Unique ID of a custom field.

Range

N/A

project_id

Integer

Definition

ID of the project to which the custom field belongs.

Range

N/A

tracker_id

Integer

Definition

Type ID of the work item to which a custom field belongs.

Range

2 (task)

3 (bug)

5 (epic)

6 (feature)

7 (story)

custom_field

String

Definition:

Name of a custom field.

Value range:

N/A

type

String

Definition:

Custom field type.

Value range:

N/A

name

String

Definition:

Display name of a custom field.

Value range:

N/A

sort

Integer

Definition:

Sequence number of a field, which is used to determine the field display sequence on the GUI.

Value range:

N/A

memo

String

Definition:

Additional information about a custom field.

Value range:

N/A

created

String

Definition:

Time when a custom field is created. Format: YYYY-MM-DD HH:mm:ss (Example: 2025-07-28 14:47:38)

Value range:

N/A

modified

String

Definition:

Time when a custom field is modified. Format: YYYY-MM-DD HH:mm:ss (DateTime format: 2025-07-28 14:47:38)

Value range:

N/A

is_delete

Boolean

Definition:

Whether a customized field is deleted.

Value range:

true: deleted

false: not deleted

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error description, which is a supplement to error_code.

Range

N/A

Example Requests

GET https://{endpoint}/v2/custom-field/query-custom-field?project_id=5192de5eb435430c8cd41c6ae6028848&tracker_id=3

Example Responses

Status code: 200

{
  "result" : {
    "custom_field" : [ {
      "tracker_list" : [ ],
      "region" : "example",
      "id" : 492316,
      "project_id" : 34883337,
      "tracker_id" : -2,
      "custom_field" : "custom_field16",
      "type" : "text",
      "name" : "Mandatory for test",
      "sort" : 1,
      "memo" : "",
      "created" : "2025-06-28 10:00:30",
      "modified" : "2025-06-28 10:00:30",
      "is_delete" : false
    } ]
  },
  "status" : "success"
}

Status code: 400

{
  "error_code" : "PM.02100011",
  "error_msg" : "No access permission."
}

Status Codes

Status Code

Description

200

OK (The request has succeeded).

400

Error response indicating no permission.

Error Codes

See Error Codes.