Help Center/ CodeArts Req/ API Reference/ API/ Work Items of a Scrum Project/ Querying the Filters Created by or Shared with the Current User
Updated on 2026-10-13 GMT+08:00

Querying the Filters Created by or Shared with the Current User

Function

This API is used to query the filters created by or shared with the current user.

Calling Method

For details, see Calling APIs.

Authorization Information

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

URI

GET /v2/query/list-all

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

projectId

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

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

N/A

Range

The value contains 10 to 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 of querying the filter lists that are created by or shared with the current user.

status

String

Definition:

Returned status of querying the filter lists that are created by or shared with the current user.

Value range:

success: Command execution succeeds.

error: Command execution failed.

Table 4 result

Parameter

Type

Description

shared

Array of strings

Definition:

Filter list shared with the current user.

Value range:

N/A

created

Array of strings

Definition:

Filter list created by the current user.

Value range:

N/A

Example Requests

{endpoint}/v2/query/list-all?project_id=381fcca9c056482d92da3e8b9da71db5

Example Responses

Status code: 200

{
  "result" : {
    "shared" : [ ],
    "created" : [ ]
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

Response to a successful request for querying the filter lists created by or shared with the current user.

Error Codes

See Error Codes.