Help Center/ CodeArts Req/ API Reference/ API/ Work Items of the Scrum Project/ Obtaining Comments on a Work Item (V2)
Updated on 2025-09-10 GMT+08:00

Obtaining Comments on a Work Item (V2)

Function

This API is used to obtain comments on a work item (V2).

Calling Method

For details, see Calling APIs.

URI

GET /v2/issues/get-comments

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition:

Pagination index. The offset is an integer multiple of limit. For example, if the value of offset is 0, the return starts from the first record. If the value of offset is 10, the return starts from the eleventh record.

Constraints:

N/A

Value range:

Minimum value: 0. Maximum value: 10,000.

Default value:

Default value: 0.

limit

No

Integer

Definition:

Number of records displayed on each page.

Constraints:

N/A

Value range:

Minimum length: 1 character. Maximum length: 10 characters.

Default value:

10

project_uuid

Yes

String

Definition:

32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API.

Constraints:

The value must contain 32 characters. Digits and letters are allowed.

Value range:

N/A

Default value:

N/A

type

Yes

String

Definition:

Project type.

Constraints:

N/A

Value range:

Scrum

Default value:

N/A

issue_id

Yes

Integer

Definition:

Work item ID, which can be obtained from the Performing Advanced Query of Work Items API. The value of the id field in the response message body is the work item ID.

Constraints:

The value must contain 1 to 10 digits.

Value range:

Minimum length: 1 character. Maximum length: 10 characters.

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token by calling the IAM API forobtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints:

Mandatory.

Value range:

Minimum length: 10 characters. Maximum length: 32,768 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

result object

Definition:

Result of querying comments on a work item.

status

String

Definition:

Returned status.

Table 4 result

Parameter

Type

Description

comments

Array of comments objects

Definition:

List of comments on a work item.

journals_total

Integer

Definition:

Total number of comments.

Value range:

N/A

Table 5 comments

Parameter

Type

Description

id

Integer

Definition:

Comment ID.

Value range:

N/A

notes

String

Definition:

Comment on a work item.

Value range:

N/A

created_on

String

Definition:

Timestamp when a comment is created, for example, 1754361449000.

Value range:

N/A

user

IssueUserVO object

Definition:

Information about the user who posts a comment.

Value range:

N/A

Table 6 IssueUserVO

Parameter

Type

Description

first_name

String

Definition:

Username.

Value range:

N/A

identifier

String

Definition:

Unique ID of the author.

Value range:

N/A

image_id

String

Definition:

User avatar ID.

Value range:

N/A

nick_name

String

Definition:

User alias.

Value range:

N/A

name

String

Definition:

Username with tenant information.

Value range:

N/A

id

Integer

Definition:

Digital ID of a user.

Value range:

N/A

Example Requests

GET https://{endpoint}/v2/issues/get-comments?issue_id=9182484&project_uuId=af2d9ea776204a4395e238dd156b2ca9&limit=10&offset=0&type=scrum&_=1753348089805

Example Responses

Status code: 200

OK (The request has succeeded).

{
  "result" : {
    "comments" : [ {
      "id" : 11260742,
      "notes" : "<p>In this time</p>",
      "created_on" : "1753348089000",
      "user" : {
        "id" : 1111,
        "name" : "xxxxxx",
        "first_name" : "xxxxxx",
        "nick_name" : "xxxxxx",
        "image_id" : "photo01.png",
        "identifier" : "xxxxxx"
      }
    }, {
      "id" : 11260741,
      "notes" : "<p>Safety</p>",
      "created_on" : "1753348085000",
      "user" : {
        "id" : 1111,
        "name" : "xxxxxx",
        "first_name" : "xxxxxx",
        "nick_name" : "xxxxxx",
        "image_id" : "photo01.png",
        "identifier" : "xxxxxx"
      }
    } ],
    "journals_total" : 2
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK (The request has succeeded).

Error Codes

See Error Codes.