View user tag list¶

View user tags in the current workspace by page. Use the list when selecting, updating, or removing a user’s tags.

POST https://api.moi.matrixorigin.cn/v5/user/tag/list

Preparation before calling¶

Prepare a personal access token that can access the target workspace and the target workspace ID.

Request parameters¶

Input example

curl -X POST "https://api.moi.matrixorigin.cn/v5/user/tag/list" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "page": 1,
    "page_size": 20
  }'

Parameter description

Parameter	Type	Required	Description
`page`	integer	No	Page number, starting at 1. The default is 1.
`page_size`	integer	No	Number of items per page. The default is 20 and the maximum is 100.

To read the next page, increase page by 1 and keep page_size unchanged. Stop when the cumulative number read reaches data.total, or when the current page’s data.tag_list is empty. The current service does not apply the sorting and filtering fields retained for compatibility in the request structure.

Successful response¶

On success, returns the total tag count and the tags on the current page.

Response example

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "total": 1,
    "tag_list": [
      {
        "id": 12,
        "name": "finance",
        "description": "Finance team"
      }
    ]
  }
}

Field details

Field	Type	Description
`code`	string	`OK` on success.
`msg`	string	`OK` on success.
`data.total`	integer	Total number of tags in the current workspace.
`data.tag_list`	object array	Tags on the current page.
`data.tag_list[].id`	integer	Tag ID.
`data.tag_list[].name`	string	Tag name.
`data.tag_list[].description`	string	Tag description.

Error response¶

Response example

{
  "code": "INVALID_ARGUMENT",
  "msg": "Invalid request parameters",
  "data": null
}

Field details

Field	Type	Description
`code`	string	Error code.
`msg`	string	Error message.
`data`	null	—

Next steps¶

Select a user tag¶

Select the tag to update, delete, or associate with a user. Continue reading by using the cursor returned by the previous page.

Last updated on Sep 11, 2026