Get List of Teams
- Print
- DarkLight
- PDF
Get List of Teams
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/teams.list
Lists the public and private teams the request sender is part of.
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
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}
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
query
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" } }
Responses
200
OK
Note that the roomId is main room id of the team.
Example 1
{
"teams": [
{
"_id": "63f3efc4b000b6b6d86704b2",
"name": "test-audit",
"type": 0,
"createdAt": "2023-02-20T22:10:12.733Z",
"createdBy": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "test.test"
},
"_updatedAt": "2023-02-20T22:10:12.843Z",
"roomId": "6GFJ3tbmHiyHbahmC",
"rooms": 0,
"numberOfUsers": 2
},
{
"_id": "65149c7ea2f73c7460e18cab",
"name": "messages",
"type": 0,
"createdAt": "2023-09-27T21:19:58.972Z",
"createdBy": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie"
},
"_updatedAt": "2023-09-27T21:19:59.038Z",
"roomId": "6513afeda2f73c7460e18c86",
"rooms": 0,
"numberOfUsers": 2
}
],
"total": 2,
"count": 2,
"offset": 0,
"success": true
}object
teams
Array of object
object
_id
string
name
string
type
integer
createdAt
string
createdBy
object
_id
string
username
string
_updatedAt
string
roomId
string
rooms
integer
numberOfUsers
integer
total
integer
count
integer
offset
integer
success
boolean
Was this article helpful?