Join a team | Vercel REST API

APIs & SDKs

Join a team

POSThttps://api.vercel.com/v1/teams/{teamId}/members/teams/join

Join a team with a provided invite code or team ID.

https://api.vercel.com/v1/teams/{teamId}/members/teams/join

const response = await fetch('https://api.vercel.com/v1/teams/teamId/members/teams/join', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "inviteCode": "fisdh38aejkeivn34nslfore9vjtn4ls"
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "from": "email",
  "name": "My Team",
  "slug": "my-team",
  "teamId": "team_LLHUOMOoDlqOp8wPE4kFo9pE"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

teamIdstringRequired

Body

application/json

inviteCodestringOptional

The invite code to join the team.

Response

200Successfully joined a team.

fromstringRequired

The origin of how the user joined.

namestringRequired

The name of the team the user joined.

slugstringRequired

The slug of the team the user joined.

teamIdstringRequired

The ID of the team the user joined.

Errors

400One of the provided values in the request body is invalid.

402Error

403You do not have permission to access this resource.

404Error

410Error

503Error

Cross-link map: Join a team (/docs/rest-api/teams/join-a-team)

From the Vercel docs graph (built 2026-10-12T05:34:10.371Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Invite a user — POST /v2/teams/{teamId}/members — Invite a user to join the team specified in the URL. The authenticated user needs to b
List team members — GET /v3/teams/{teamId}/members — Get a paginated list of team members for the provided team.
Request access to a team — POST /v1/teams/{teamId}/request — Request access to a team as a member. An owner has to approve the request. Only 100 us
Create a Team — POST /v1/teams — Create a new Team under your account. You need to send a POST request with the desired Team slug, and..
Get access request status — GET /v1/teams/{teamId}/request/{userId} — Check the status of a join request. It'll respond with a 404 if the request ha

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v1/teams/{teamId}/members/teams/join

const response = await fetch('https://api.vercel.com/v1/teams/teamId/members/teams/join', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "inviteCode": "fisdh38aejkeivn34nslfore9vjtn4ls"
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "from": "email",
  "name": "My Team",
  "slug": "my-team",
  "teamId": "team_LLHUOMOoDlqOp8wPE4kFo9pE"
}

OpenAPI Specification