Get List of All Teams

Prev Next
Get
/api/v1/teams.listAll

Lists all the teams and their information.

Permission required: view-all-teams

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. Refer to the official documentation to learn more.

Example50
count
integer

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

Example50
Responses
200

OK Note that the roomId is main room ID of the team.

Success
{
  "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": "6435624052492a08c3a756fd",
      "name": "Test-team",
      "type": 0,
      "createdAt": "2023-04-11T13:36:00.496Z",
      "createdBy": {
        "_id": "rYhzFRd2QZjNwAAXX",
        "username": "rodriq"
      },
      "_updatedAt": "2023-04-11T13:36:00.855Z",
      "roomId": "h5gPM3Wpip8nEFwbu",
      "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": 3,
  "count": 3,
  "offset": 0,
  "success": true
}
Expand All
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
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string