Get Status

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/api/v1/users.getStatus

Gets a user's status in your workspace.

Version	Description
1.2.0	Added

Query parameters

userId

string

The userId of the user. Alternatively, you can use the username property and value. If the value is not provided, the authenticated user is used.

ExampleW7NHuX5ri2e3mu2Fc

Responses

200

Success Example

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

object

message

string

connectionStatus

string

status

string

success

boolean

401

Unauthorized

Authorization Error

{
  "status": "error",
  "message": "You must be logged in to do this."
}

object

status

string

message

string

Was this article helpful?