Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Repository/ Obtaining a Repository Tag List

Updated on 2026-01-27 GMT+08:00

View PDF

Obtaining a Repository Tag List

Function

This API is used to obtain a repository tag list.

Debugging

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

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
codeartsrepo:repository:getRepository	Read	-	-	-	-

URI

GET https://{hostURL}/v4/repositories/{repository_id}/labels

**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 Default Value 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
search	No	String	Definition: Search keywords. The tag name can be fuzzily matched. Constraints: N/A. Value range: N/A. Default value: N/A.
sort	No	String	Definition: Sorting order Constraints: N/A Value range: name_asc: Sort by tag name in ascending order. name_desc: Sort by tag name in descending order. created_asc: Sort by tag creation time in ascending order. created_desc: Sort by tag creation time in descending order. updated_desc: Sort by tag update time in descending order. -updated_asc: Sort by tag update time in ascending order. Default value: name_asc Default value:* name_asc Enumeration values: name_asc name_desc created_asc created_desc updated_asc updated_desc
include_expired	No	Boolean	Definition: Whether it includes invalid tags. Constraints: N/A. Value range: true: Yes. false: No. Default value: true Default value: true
view	No	String	Definition: Result set attribute. Different results are returned based on the given parameters. Constraints: N/A. Value range: simple: Return brief information. basic: Return basic information. detail: Return detailed information. Default value: basic Default value: basic Enumeration values: simple basic detail

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token. Constraints N/A Range 1–100,000 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
[items]	Array of objects	Tag list.

Example Requests

None

Example Responses

Status code: 200

Repository tag list.

[ {
  "id" : 115,
  "name" : "bug",
  "color" : "#6BC950",
  "description" : "",
  "text_color" : "#FFFFFF",
  "expires_at" : "2025-06-10",
  "is_expired" : true,
  "open_merge_requests_count" : 0,
  "priority" : 0,
  "is_repository_label" : true
} ]