List all the members of a DM.
Changelog
| Version | Description |
|---|---|
| 0.59.0 | Added |
The authToken of the authenticated user.
The userId of the authenticated user.
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.
List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, { "value": -1, "_id": 1 }. Refer to the official documentation to learn more.
This parameter allows you to use MongoDB query operators to search for specific data. For example, to query users with a name that contains the letter "g": query={ "name": { "$regex": "g" }}. Refer to the official documentation to learn more.
The room ID of the DM. It is required if username is not provided.
The username of the user in the DM. It is required if roomId is not provided.
OK
{
"members": [
{
"_id": "5fRTXMt7DMJbpPJfh",
"username": "test.john",
"status": "online",
"name": "Test John",
"utcOffset": 1,
"statusText": ""
},
{
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie",
"status": "offline",
"name": "test test",
"utcOffset": 1,
"statusText": "On a vacation"
},
{
"_id": "hFDuCPam7sWziWFYa",
"status": "offline",
"name": "Hookdeck Write",
"utcOffset": 1,
"username": "hookdeck.write"
}
],
"count": 3,
"offset": 0,
"total": 3,
"success": true
}Bad Request
{
"success": false,
"error": "must have required property 'roomId'\n must have required property 'username'\n must match exactly one schema in oneOf [invalid-params]",
"errorType": "invalid-params"
}{
"success": false,
"error": "[invalid-channel]",
"errorType": "invalid-channel"
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}