POST
/
teams

Authorizations

Authorization
string
headerrequired

Default authentication mechanism

Body

application/json
name
string
required
Required string length: 1 - 32
slug
string
required
Required string length: 3 - 48
description
string
Maximum length: 120

Response

200 - application/json
_id
string
required

The unique ID of the team.

name
string
required

The name of the team.

logo
string | null
required

The logo of the team.

description
string | null
required

The description of the team.

Maximum length: 120
membersCount
number
required

The members count of the team.

meta
object
required

The meta of the team.

inviteCode
string
required

The invite code of the team.

Maximum length: 24
plan
enum<string>
required

The plan of the team.

Available options:
free,
pro,
business,
enterprise
billingCycleStart
number
required

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

usage
object
required

The usage of the resource of a team.

limit
object
required

The limit of the team resources.

createdAt
string
required

The date and time when the team was created.

updatedAt
string
required

The date and time when the team was last updated.

role
any

The role of the authenticated user in the team.

Was this page helpful?

Retrieve a list of teamRetrieve a team