Get Team Information

Gets a team's information. If the team is not public, the request sender must be a member of the team.

HTTP MethodURLRequires Auth



Query Parameters

KeyExample ValueDescription

teamId* or teamName*

ByehQjC44FwMeiLbX or team1

The team ID or the team name. You must enter either one of these parameters.

Example Call

curl  -H "X-Auth-Token: 8h2mKAwxB3AQrFSjLVKMooJyjdCFaA7W45sWlHP8IzO" \
      -H "X-User-Id: ew28FnZqipDpvKw3R" \
      -H "Content-type: application/json" \

Example Response

  "teamInfo": {
    "_id": "607e0d9b49d493189836bfac",
    "name": "Team1",
    "type": 1,
    "createdAt": "2021-04-19T23:09:15.106Z",
    "createdBy": {
      "_id": "FL2fZL4ERhwA3gWiS",
      "username": "some.username"
    "_updatedAt": "2021-04-19T23:09:15.106Z",
    "roomId": "Dgh2xwJ3NFKWvKSqY"
  "success": true

roomId is the team's main room ID.

Last updated

Rocket.Chat versions receive support for six months after release.