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
count
integer

The number of items to return. Refer to the official documentation to learn more.

Example50
offset
integer

Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.

Example50
sort

Sort the order of custom user status in ascending (1) or descending (-1) order. The options are:

  • name: Sort by name. For example, sort={"name": 1} (default) or sort={"name": -1}.
  • statusType: Sort by status type. For example, sort={"statusType": 1} or sort={"statusType": -1}.
  • You can also sort using both parameters. For example, sort={"name": 1, "statusType": -1}.
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