GET
/
teams
/
{team_slug}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
team_slug
string
required

The slug of the team.

Response

200 - application/json
​
_id
string
required

The unique ID of the team.

​
billingCycleStart
number
required

The date and time when the billing cycle starts for the team.

​
createdAt
string
required

The date and time when the team was created.

​
description
string | null
required

The description of the team.

Maximum length: 120
​
inviteCode
string
required

The invite code of the team.

Maximum length: 24
​
limit
object
required

The limit of the team resources.

The logo of the team.

​
membersCount
number
required

The members count of the team.

​
meta
object
required

The meta of the team.

​
name
string
required

The name of the team.

​
plan
enum<string>
required

The plan of the team.

Available options:
free,
pro,
business,
enterprise
​
updatedAt
string
required

The date and time when the team was last updated.

​
usage
object
required

The usage of the resource of a team.

​
role
any

The role of the authenticated user in the team.

Was this page helpful?

Suggest edits
Create a teamupdate a team