Website
Community
User Documentation
Free Trial
Search…
Rocket.Chat Developer
Quick Start
Choosing a Deployment Host
Setting up your Development Environment
Rocket.Chat
Rocket Chat Environment Setup
Repository Structure
Deeplink
Two Factor Authentication
Embedded Layout
White Labelling Rocket.Chat
Iframe Integration
Contribute to Rocket.Chat
Mobile App
Mobile App Environment Setup
Testing your Mobile App
Mobile App White Labelling
Mobile App FAQs
Desktop App
Desktop App Environment Setup
Developing your Desktop App
Debugging your Desktop App
Desktop App White Labelling
Omnichannel
Omnichannel Environment Setup
Developing Omnichannel Apps
Livechat Widget Development and Customization
Omnichannel FAQs
Apps Engine
Rocket.Chat App
Rocket.Chat Apps Engine
Getting Started
Adding Features
Testing your App
Sample App Snippets
Slack Compatibility
App Submission to the Marketplace
Apps-Engine API Reference
Bots
Bots Development Environment Setup
Bots Architecture
Creating Your Own Bot From Scratch
Bots FAQs
Reference
Database Schema
API
Deprecation
Schema Definition
Schema Definition v2 (Draft)
Realtime API
REST API
Endpoints
Omnichannel
Team Collaboration Endpoints
Assets Endpoints
Auto Translate Endpoints
Banners Endpoints
Channels Endpoints
Chat Endpoints
Cloud Endpoints
Commands Endpoints
Custom Sounds Endpoints
Custom User Status Endpoints
Custom User Status List
Create custom user status
Delete custom user status
Update custom user status type
DNS Endpoints
E2E Endpoints
Email Inbox Endpoints
Custom Emoji Endpoints
Groups Endpoints
IM Endpoints
Import Endpoints
Instances Endpoints
Integration Endpoints
Invite Endpoints
Miscellaneous Endpoints
OAuthApps Endpoints
Permissions Endpoints
Push Token Endpoints
Roles Endpoints
Rooms Endpoints
Settings Endpoints
Stats Endpoints
Subscriptions Endpoints
Teams Endpoints
Users Endpoints
Video Conference Endpoints
Webdav Endpoint
Other Important Endpoints
Apps Endpoints
Avatars
Livechat Widget API
Fuselage
Contributing
Powered By
GitBook
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
1
curl
-H
"X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq"
\
2
-H
"X-User-Id: aobEdbYhXfu5hkeqG"
\
3
http://localhost:3000/api/v1/custom-user-status.list
Copied!
Result
Success
1
{
2
"statuses"
:
[
3
{
4
"_id"
:
"oGxJ2irQcPkgFLGef"
,
5
"name"
:
"status 1"
,
6
"statusType"
:
"busy"
,
7
"_updatedAt"
:
"2019-12-09T20:26:06.477Z"
8
},
9
{
10
"_id"
:
"d3TjnQgKWttgaW9Hh"
,
11
"name"
:
"status 2"
,
12
"statusType"
:
"online"
,
13
"_updatedAt"
:
"2019-12-09T20:25:10.884Z"
14
}
15
],
16
"count"
:
2
,
17
"offset"
:
0
,
18
"total"
:
4
,
19
"success"
:
true
20
}
Copied!
Errors
The following error can occur upon the endpoint.
Authorization
: Requires an authentication token for the request to be made.
Authorization
1
{
2
"success"
:
false
,
3
"error"
:
"unauthorized"
4
}
Copied!
Change Log
Version
Description
2.4.0
Added
Previous
Custom User Status Endpoints
Next
Create custom user status
Last modified
7mo ago
Export as PDF
Copy link
Edit on GitHub
Contents
Example Call
Result
Success
Errors
Change Log