Skip to main content

teams

Overview

Nameteams
TypeResource
Idvercel.teams.teams

Fields

NameDatatypeDescription
idstringThe Team's unique identifier.
namestringName associated with the Team account, or null if none has been provided.
avatarstringThe ID of the file used as avatar for this Team.
slugstringThe Team's slug, which is unique across the Vercel platform.

Methods

NameAccessible byRequired ParamsDescription
get_teamSELECTteamIdGet information for the Team specified by the teamId parameter.
get_teamsSELECTGet a paginated list of all the Teams the authenticated User is a member of.
create_teamINSERTdata__slugCreate a new Team under your account. You need to send a POST request with the desired Team slug, and optionally the Team name.
delete_teamDELETEteamIdDelete a team under your account. You need to send a DELETE request with the desired team id. An optional array of reasons for deletion may also be sent.
_get_teamsEXECGet a paginated list of all the Teams the authenticated User is a member of.
join_teamEXECteamIdJoin a team with a provided invite code or team ID.
patch_teamEXECteamIdUpdate the information of a Team specified by the teamId parameter. The request body should contain the information that will be updated on the Team.