Updated on 2026-10-13 GMT+08:00

Exporting Work Items (V2)

Function

This API is used to export work items (V2).

Calling Method

For details, see Calling APIs.

Authorization Information

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

URI

POST /v2/issues/export-reqs-new

Request Parameters

**Table 1** 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 N/A Range The value contains 10 to 32,768 characters. Default Value N/A

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
projectUUId	No	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 A string of 32 characters consisting of digits and letters. Range N/A Default Value N/A
fields	No	String	Definition Column fields to be exported. Use commas (,) to separate values. Constraints N/A Range id: work item ID subject: title closed_on: completion time status: status assigned_to: handler start_date: estimated start date due_date: estimated end date priority: priority created_on: creation time actual_work_hours: actual workloads done_ratio: completion rate tracker: work item type module: module order: priority sequence severity: severity parent_issue: parent work item domain: domain expected_work_hours: estimated work hours fixed_version: iteration env: discovery environment story_point: story point tag_id: tag ID. description: description author: creator assigned_cc: CC recipient developer: developer updated_on: update time Default Value N/A
export_child	No	Boolean	Definition Whether to export child work items. Constraints N/A Range true: Export child work items. false: Do not export child work items. Default Value N/A
type	No	String	Definition Structure type of the exported work item. Constraints N/A Range tree list Default Value N/A
time_zone	No	Integer	Definition: Time zone, for example, 8. Constraints: N/A Value range: N/A Default value: N/A
page_no	No	Integer	Definition: Page index. Constraints: N/A Value range: Minimum value: 0. Maximum value: 9,999,999,999. Default value: N/A
page_size	No	Integer	Definition: Page size. Constraints: N/A Value range: Minimum value: 0. Maximum value: 9,999,999,999. Default value: N/A
export_all	No	Boolean	Definition Whether to export all fields. Constraints N/A Range true: Export all fields. false: Export selected fields. Default Value N/A
tracker_id	No	String	Definition Work item type ID. Constraints N/A Range 2: task 3: bug 5: epic 6: feature 7: story Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
-	File	Definition: File. Value range: N/A

Example Requests

POST https://{endpoint}/v2/issues/export-reqs-new?_=1753102328713

{
  "projectUUId" : "d00fd603ddf64115939e7d3609d6cb05",
  "fields" : "id,subject,closed_on,status,assigned_to,start_date,due_date,priority,created_on,actual_work_hours,done_ratio,tracker,module,order,severity,parent_issue,domain,releaseDev,expected_work_hours,fixed_version,findReleaseDev,env,story_point,tag_id,description,author,assigned_cc,developer,updated_on",
  "export_child" : "false",
  "type" : "tree",
  "time_zone" : 8,
  "page_no" : 1,
  "page_size" : 2000,
  "export_all" : "false",
  "tracker_id" : "5,6,7,2,3"
}

Example Responses

None

Status Codes

Status Code	Description
200	Response to a successful request for exporting work items.

Error Codes

See Error Codes.

Parent topic: Work Items of a Scrum Project