Help Center/ Workspace/ API Reference/ Workspace APIs/ AI Function/ Querying Projects, User Groups, and Users with AI Assistant Subscriptions
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Querying Projects, User Groups, and Users with AI Assistant Subscriptions

Function

Queries the projects, user groups, and users with AI Assistant Subscriptions.

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 has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:users:listSubscribeAiAssistantUsers

    List

    -

    -

    -

    -

URI

GET /v3/users/ai-assistant/subscribe

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Limits the quantity of returned users in pagination query. If this parameter is not specified, all users who meet the query criteria are returned.

offset

No

Integer

Start number of records in pagination query.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

total_count

Integer

Total number of users with subscriptions.

users

Array of SubscribeUserInfo objects

List of users with subscriptions.

usergroups

Array of SubscribeUserGroupInfo objects

List of user groups with subscriptions.

project

project object

Information about projects with subscriptions.
Table 3 SubscribeUserInfo

Parameter

Type

Description

user_id

String

User ID.

user_name

String

Desktop username.

user_phone

String

Mobile number of the user.

ai_func

Boolean

Whether the AI function is enabled.

  • true: enabled

  • false: disabled
Table 4 SubscribeUserGroupInfo

Parameter

Type

Description

group_id

String

User group ID.

group_name

String

User group name.

ai_func

Boolean

Whether the AI function is enabled.

  • true: enabled

  • false: disabled
Table 5 project

Parameter

Type

Description

project_id

String

Project ID.

ai_func

Boolean

Whether the AI function is enabled.

  • true: enabled

  • false: disabled

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 405

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 503

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

GET /v2/0bec5db98280d2d02fd6c00c2de791ce/users/ai-function/subscribe?limit=10

Example Responses

Status code: 200

Response to the request for querying AI assistant subscribers.

{
  "total_count" : 100,
  "users" : [ {
    "user_id" : "1c873056-9f4d-11ec-b909-0242ac120002",
    "ai_func" : true
  } ],
  "usergroups" : [ {
    "group_id" : "8885bcc45da1f762015da20130a1000",
    "ai_func" : false
  } ],
  "project" : {
    "project_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
    "ai_func" : true
  }
}

Status Codes

Status Code

Description

200

Response to the request for querying AI assistant subscribers.

400

The request cannot be understood by the server due to malformed syntax.

401

Authorization failed.

403

No permissions.

404

Resources not found.

405

The method specified in the request is not allowed.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: AI Function