Links

Custom User Status List

Lists all available custom user's status.
URL
Requires Auth
HTTP Method
/api/v1/custom-user-status.list
yes
GET

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/custom-user-status.list

Result

Success

{
"statuses": [
{
"_id": "oGxJ2irQcPkgFLGef",
"name": "status 1",
"statusType": "busy",
"_updatedAt": "2019-12-09T20:26:06.477Z"
},
{
"_id": "d3TjnQgKWttgaW9Hh",
"name": "status 2",
"statusType": "online",
"_updatedAt": "2019-12-09T20:25:10.884Z"
}
],
"count": 2,
"offset": 0,
"total": 4,
"success": true
}

Errors

The following error can occur upon the endpoint.
  • Authorization: Requires an authentication token for the request to be made.
Authorization
{
"success": false,
"error": "unauthorized"
}

Change Log

Version
Description
2.4.0
Added
Last modified 1yr ago
Deprecation for cloud services and apps is now extended to November 20, 2023. Rocket.Chat versions receive support for six months after release.