List Custom User Status
- Print
- DarkLight
- PDF
List Custom User Status
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/custom-user-status.list
Lists all available custom user's status.
Changelog
| Version | Description |
|---|---|
| 2.4.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Responses
200
OK
Success Example
{
"statuses": [
{
"_id": "63f61be0b000b6b6d86704c8",
"name": "brb",
"statusType": "away",
"_updatedAt": "2023-02-22T13:42:56.811Z"
}
],
"count": 1,
"offset": 0,
"total": 1,
"success": true
}object
statuses
Array of object
object
_id
string
name
string
statusType
string
_updatedAt
string
count
integer
offset
integer
total
integer
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?