Query a Specific User

Query the detailed information of a specific user.

Request URL

GET {base_url}/services/openapi/v1.0/user/user_detail/{memberId}

Request parameters

Path parameter


Parameter	Required	Type	Description
memberId	Yes	Long	User's member ID. Note: You can query the user's member ID using the Query Multiple Users interface.

Response parameters


Parameter	Type	Description
data	Object <Details>	The detailed information.
status	String	The result of the request. `Success` `Failed`
requestId	String	The ID of the request, which can be used to quickly locate the request.

Details


Parameter	Type	Description
userId	Long	User's account ID.
memberId	Long	User's member ID.
inviteStatus	String	Account invitation status. `outer`: Inactive. `invite`: Invited. `added`: Joined.
email	String	Email address.
firstName	String	First name.
lastName	String	Last name.
groupIds	Array <Long>	The ID(s) of the group(s) that the user belongs to.
roleName	String	User role name.
preferredBuildingName	String	The name of the building where the user's workplace is located.
preferredFloorName	String	The name of the floor where the user's workplace is located.
phone	String	Mobile phone number.
idCode	String	The identification code that administrator set to identify the user.

Example

Request example

Query the information of a specific user (member ID: 466).

GET /services/openapi/v1.0/user/user_detail/466 HTTP/1.1
Host: workplace.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiL29wZW5hcGkvIl0sImVudGVycHJpc2VfaWQiOjEwMDQzMywicmVnaW9uIjoiR0wiLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJjZjc3NTg4OC1mM2QwLTRkNDMtODJiYy00NjQ4NWZjYTY0MzIiLCJjbGllbnRfaWQiOiI3OTU2OGFhMC0wYjBkLTQyZjYtOGRiNC03OWExNmQ3MzQ3MmEiLCJ0cyI6MTY4OTkwNTE3MCwiZXhwX2luIjo4NjQwMH0.QULcMVk5CJWNnZFrHp2TYH-P1cdvPoFn4jYYEwSs0Ps

Response example

HTTP/1.1 200 OK
{
    "data": {
        "userId": 10466,
        "memberId": 466,
        "inviteStatus": "added",
        "email": "rebecca@yeastar.com",
        "firstName": "Rebecca",
        "groupIds": [
            1000127
        ],
        "roleName": "Administrator",
        "preferredBuildingName": "Yeastar"
    },
    "status": "Success",
    "requestId": "dde383e3781d968f476f39ca57eed4d4"
}