List DM Members
- Print
- DarkLight
- PDF
List DM Members
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/im.members
List all the members of a DM.
Changelog
| Version | Description |
|---|---|
| 0.59.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
offset
integer
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.
Example50
count
integer
The number of items to return.
Example50
sort
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 }
roomId
string
The room ID of the DM. It is required if username is not provided.
username
string
The username of the user in the DM. It is required if roomId is not provided.
Responses
200
OK
Example 1
{
"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
}object
members
Array of object
object
_id
string
username
string
status
string
name
string
utcOffset
integer
statusText
string
count
integer
offset
integer
total
integer
success
boolean
400
Bad Request
Example 1
{
"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"
}Example 2
{
"success": false,
"error": "[invalid-channel]",
"errorType": "invalid-channel"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?