List Custom User Status

Prev Next
Get
/api/v1/custom-user-status.list

Lists all available custom user's status.

Changelog

Version Description
7.0.0 Added name and _id query parameters for filtering.
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
Query parameters
name
string

Filter list by the name of the custom status.

Examplelunch
_id
string

Filter list by the _id of the custom status.

Example6731e2ce3b74d3c57d334d0f
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
}
Expand All
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