Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ ThirdParty/ Obtaining the Work Item List in a Repository
Updated on 2026-04-28 GMT+08:00
View PDF

Obtaining the Work Item List in a Repository

Function

This API is used to obtain the list of work items in a repository.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET https://{hostURL}/v4/repositories/{repository_id}/work-items

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Definition

You can query the project list to obtain the repository ID by calling the API used to query user's all repositories.

Constraints

N/A.

Value range:

1~2147483647
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Offset, which starts from 0.

Value range:

0~2147483647

Default value:

0

limit

No

Integer

Definition

Number of returned records.

Value range:

1~100

Default value:

20

project_id

Yes

String

Definition:

You can obtain the unique project identifier, 32-character UUID, by calling the API used to query the project list.

Value range:

32 characters

is_ipd

Yes

Boolean

Definition:

Whether the work item is of the IPD project type.

Value range:

true or false

subject

No

String

Definition:

Keyword for searching work item titles.

Value range:

1 to 200 characters.

target_branch

No

String

Definition:

Target branch of a merge request. If you want to obtain the list of work items that can be associated with a merge request, this field is required.

Constraints:

Do not start with hyphen (-), period (.) refs, heads, refs, or remotes. Do not end with . / .lock. Spaces and the following characters are not supported: [ \ < ~ ^ : ? * ! ( ) ' " |

Value range:

1 to 200 characters.

Default value:

N/A.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

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

Constraints

Mandatory.

Range

1–100,000 characters.

Default Value

N/A.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Total

String

Definition:

Total number of results of the current request.
Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of ReqWorkItemDto objects

Definition:

Work item data.
Table 6 ReqWorkItemDto

Parameter

Type

Description

id

String

Definition:

Work item ID.

subject

String

Definition:

Work item title.

sequence

String

Definition:

Work item ID. This parameter is left empty for Scrum projects.

tracker

ReqWorkItemBasicDto object

Definition:

Work item type.

status

ReqWorkItemBasicDto object

Definition:

Work item status.

priority

ReqWorkItemBasicDto object

Definition:

Work item priority.
Table 7 ReqWorkItemBasicDto

Parameter

Type

Description

id

String

Definition:

Property ID.

name

String

Definition:

Attribute name.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

GET https://{endpoint}/v4/repositories/1/work-items?project_id=ac90e21856c04707a041fbe2a9a020dc&is_ipd=false&offset=0&limit=10

Example Responses

Status code: 200

OK

[ {
  "id" : "1096177668293902337",
  "subject" : "2",
  "sequence" : "IR20250211809298",
  "tracker" : {
    "id" : "7",
    "name" : "Story"
  },
  "status" : {
    "id" : "1",
    "name" : "New."
  },
  "priority" : {
    "id" : "2",
    "name" : "Medium."
  }
} ]

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Bad Request

Error Codes

See Error Codes.

Parent topic: ThirdParty