Get
/api/v1/users.getStatus
Gets a user's status in your workspace.
Changelog
| Version | Description |
|---|---|
| 8.6.0 | Added statusSource and statusExpiresAt response fields. |
| 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
OK
Success Example
{
"_id": "W7NHuX5ri2e3mu2Fc",
"connectionStatus": "online",
"status": "online",
"statusSource": "manual",
"statusExpiresAt": "2026-06-22T18:00:00.000Z",
"success": true
}object
_id
string
The user ID.
connectionStatus
string
The connection status. Returned when requesting the authenticated user's own status.
status
string
statusSource
string
The claim that set the current status. One of internal, manual, or external. Omitted when the user has no recorded status source.
statusExpiresAt
string
Date as an ISO 8601 string indicating when the current status expires. Omitted when the status has no expiration.
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string