Skip to main content

GetAllUsersInWorkspace

Get all users in a group (not recommended)

Description​

  • This API is obsolete for backward compatibility. Use of [GetUsersInGroup] (GetUsersInGroup) is recommended.
  • Obtains data for all users under the specified group.

Method​

GET

Request URL​

/api/v0/users/all/g/:group-id

Params​

group-id :  Group ID

Query Param​

recursive        : true  //Traverse down the group hierarchy to retrieve all users who belong to it.

Request Sample​

GET https://api.xxx.com/api/v0/users/all/g/582b26d8fb90a15e0c24ad81?recursive=true

Response Sample​

{
    "members": [
        {
            "confirmed": false,
            "email": "[email protected]",
            "email_sent": false,
            "profile_pics": [
                {
                    "mediaLink": "https://storage.googleapis.com/linker/pub/default.png"
                }
            ],
            "u_id": "58a29e35bf400ddced9fede3",
            "username": "hi__12",
            "user_roles": [],
            "user_code": "user_code12"
        },
        {
            "confirmed": false,
            "email": "[email protected]",
            "email_sent": false,
            "profile_pics": [
                {
                    "mediaLink": "https://storage.googleapis.com/linker/pub/default.png"
                }
            ],
            "u_id": "58a29e36bf400ddced9fede4",
            "username": "hi__13",
            "user_roles": [],
            "user_code": "user_code13"
        },
        :
        :(Omission)
        :
        {
            "confirmed": false,
            "email": "[email protected]",
            "email_sent": false,
            "profile_pics": [
                {
                    "mediaLink": "https://storage.googleapis.com/linker/pub/default.png"
                }
            ],
            "u_id": "58466a7afb90a1024d298306",
            "username": "test222",
            "user_roles": [],
            "user_code": "user_code222"
        }
    ],
    "totalMembers": 10
}