get-user-status.md

Get User Status

HTTP Method	URL	Requires Auth
GET	/api/v1/users.getStatus	yes

Query Parameters

Key	Example Value	Description
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

Version	Description
1.2.0	Added