Get User Status

HTTP MethodURLRequires Auth

GET

/api/v1/users.getStatus

Query Parameters

KeyExample ValueDescription

userId or username

BsNr28znDkG8aeo7W or bobsmith

The ID or username of the user. If not provided, the status of the user who is sending the request is returned.

Example Call

With the userId query parameter:

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     http://localhost:3000/api/v1/users.getStatus?userId=BsNr28znDkG8aeo7W

With no query parameter:

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     http://localhost:3000/api/v1/users.getStatus

Example Response

{
    "message": "Latest status",
    "connectionStatus": "online",
    "status": "online",
    "success": true
}

Change Log

VersionDescription

1.2.0

Added

Last updated

Rocket.Chat versions receive support for six months after release.