Get Team Info
- Print
- DarkLight
- PDF
Get Team Info
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/teams.info
Gets a team's information. If the team is not public, the request sender must be a member of the 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
teamId
string
The team id. It is required if the teamName is not provided.
Example63f3efc4b000b6b6d86704b2
teamName
string
The team name. It is required if the teamId is not provided.
Examplelivestream
Responses
200
OK
Note that the roomId is main room id of the team.
Example 1
{
"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
}object
teamInfo
object
_id
string
name
string
type
integer
createdAt
string
createdBy
object
_id
string
username
string
_updatedAt
string
roomId
string
success
boolean
Was this article helpful?