Get
/api/v1/users.getPresence
Changelog
| Version | Description |
|---|---|
| 0.49.0 | Updated to support userId or username |
| 0.48.0 | Renamed to users.getPresence |
| 0.35.0 | Added |
Header parameters
X-User-Id
stringRequired
The authenticated user ID.
ExamplerbAXPnMktTFbNpwtJ
X-Auth-Token
stringRequired
The authenticated user token.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
Query parameters
userId
string
The user ID. Alternatively, you can enter the username parameter. If not provided, the user who sending the request is retrieved.
ExampleBsNr28znDkG8aeo7W
Responses
200
Success Example
{
"presence": "offline",
"success": true
}object
presence
string
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string