List Team Members
- Print
- DarkLight
- PDF
List Team Members
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/teams.members
List all members of a team.
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
teamName
string
The team name. It is required if the teamId is not provided.
Examplelivestream
teamId
string
The team id. It is required if the teamName is not provided.
Example63f3efc4b000b6b6d86704b2
name
string
Search filter for the user's name
Exampletest
username
string
Search filter for the user's username
Exampletest.user
status
array of string
Search filter for the user's status
Example["online", "away", "busy"]
Responses
200
OK
Success
{
"members": [
{
"user": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie",
"name": "test test",
"status": "offline",
"settings": {
"preferences": {
"themeAppearence": "light"
},
"profile": {}
}
},
"roles": [
"owner"
],
"createdBy": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "test.test"
},
"createdAt": "2023-02-20T22:10:12.740Z"
},
{
"user": {
"_id": "5fRTXMt7DMJbpPJfh",
"username": "test.test",
"name": "Testtest",
"status": "offline",
"settings": {
"profile": {}
}
},
"createdBy": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "test.test"
},
"createdAt": "2023-07-11T00:23:01.346Z"
}
],
"total": 2,
"count": 2,
"offset": 0,
"success": true
}object
members
Array of object
object
user
object
_id
string
username
string
name
string
status
string
settings
object
preferences
object
themeAppearence
string
profile
object
roles
Array of string
string
createdBy
object
_id
string
username
string
createdAt
string
total
integer
count
integer
offset
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?