Querying Work Item Workloads of a Scrum Project

Function

This API is used to query work item workloads.

Calling Method

For details, see Calling APIs.

URI

GET /v3/projects/{project_uuid}/issues/{issue_id}/work-hours

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
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
issue_id	Yes	String	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 for obtaining 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: Returned result.
status	String	Definition: Returned status. Value range: success: The API is successfully called. error: The API call failed.

**Table 4** result
Parameter	Type	Description
total	Integer	Definition: Total number of workload records. Value range: N/A
data	Array of data objects	Definition: Workload records of a work item.

**Table 5** data
Parameter	Type	Description
id	String	Definition: Workload record ID. Value range: N/A
issue_id	Integer	Definition: Work item ID. Value range: N/A
user_id	String	Definition: User ID. Value range: N/A
user_num_id	Integer	Definition: Digital ID of a user. Value range: N/A
user_name	String	Definition: Username. Value range: N/A
nick_name	String	Definition: User alias. Value range: N/A
work_date	String	Definition: Workload date, in the format of yyyy/MM/dd, for example, 2025/07/25. Value range: N/A
work_date_timestamp	String	Definition: Workload date, in timestamp format, for example, 1839340800000. Value range: N/A
work_hours	String	Definition: Workloads (unit: person-hour). Value range: N/A

Example Requests

{endpoint}/v3/projects/381fcca9c056482d92da3e8b9da71db5/issues/69813204/work-hours

Example Responses

Status code: 200

Response to a successful request for querying work item workloads.

{
  "result" : {
    "total" : 1,
    "data" : [ {
      "id" : "e7557fef692011f09df2fa163eed4f94",
      "issue_id" : 9184553,
      "user_id" : "xxxxxx",
      "user_num_id" : 1111,
      "user_name" : "xxxxxx",
      "nick_name" : "xxxxxx",
      "work_date" : "2025/07/25",
      "work_date_timestamp" : "1753372800000",
      "work_hours" : "1.0"
    } ]
  },
  "status" : "success"
}