Query All Subordinate Users

Query the base information of all subordinate users.

Request URL

GET {base_url}/dm/open_api/v1/user_info/subordinates

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String Pass the access token in the header.

Format: Bearer {access_token}.
Query parameters
Parameter Required Type Description
pageSize No Integer Define how many records per page.
  • Default value: 10
  • Maximum value: 50
pageNumber No Integer Define which page is displayed.
  • Default value: 1
query No Integer Enter a keyword for fuzzy search.

Response parameters

Parameter Type Description
data Object <Details> The detailed information.
requestId String The unique ID of the request, which can be used to quickly locate the request.
status String Request result:
  • Success
  • Failed
time Long The response time.
Note: The YCM API response returns a timestamp, you can convert the timestamp to detailed date and time as needed. For more information, see Convert Timestamp to Local Date and Time.
Details
Parameter Type Description
pageSize Integer How many records are displayed per page.
pageNumber Integer Which page is displayed.
total Integer The total number of subordinate users.
list Array <User_Info> The base information list of the subordinate user.
User_Info
Parameter Type Description
userId Long The ID of the user.
userName String The name of the user.
userEmail String The email of the user.

Example

Request example

GET /dm/open_api/v1/users/subordinates HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******

Response example

HTTP/1.1 200 OK
{
    "data": {
        "pageSize": 10,
        "pageNumber": 1,
        "total": 3,
        "list": [
            {
                "userId": 405427,
                "userName": "Charlotte",
                "userEmail": "Charlotte@yeastar.com"
            },
            {
                "userId": 359054,
                "userName": "Sophia",
                "userEmail": "huqy@yeastar.com"
            },
            {
                "userId": 318902,
                "userName": "Malinda",
                "userEmail": "malinda@yeastar.com"
            }
        ]
    },
    "requestId": "878d9869ba18c7c0fb6cc7b3d031e4e5",
    "status": "Success",
    "time": 1766552544
}