List team members - Vercel API Docs

GET

teams

{teamId}

members

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.teams.getTeamMembers({
    limit: 20,
    since: 1540095775951,
    until: 1540095775951,
    role: "OWNER",
  });

  // Handle the result
  console.log(result);
}

run();

{
  "members": [
    {
      "avatar": "123a6c5209bc3778245d011443644c8d27dc2c50",
      "confirmed": true,
      "email": "jane.doe@example.com",
      "github": {
        "login": "<string>"
      },
      "gitlab": {
        "login": "<string>"
      },
      "bitbucket": {
        "login": "<string>"
      },
      "role": "OWNER",
      "uid": "zTuNVUXEAvvnNN3IaqinkyMw",
      "username": "jane-doe",
      "name": "Jane Doe",
      "createdAt": 1588720733602,
      "accessRequestedAt": 1588820733602,
      "joinedFrom": {
        "origin": "teams",
        "commitId": "<string>",
        "repoId": "<string>",
        "repoPath": "<string>",
        "gitUserId": "<string>",
        "gitUserLogin": "<string>",
        "ssoUserId": "<string>",
        "ssoConnectedAt": 123,
        "idpUserId": "<string>",
        "dsyncUserId": "<string>",
        "dsyncConnectedAt": 123
      },
      "projects": [
        {
          "name": "<string>",
          "id": "<string>",
          "role": "ADMIN"
        }
      ]
    }
  ],
  "emailInviteCodes": [
    {
      "accessGroups": [
        "<string>"
      ],
      "id": "<string>",
      "email": "<string>",
      "role": "OWNER",
      "isDSyncUser": true,
      "createdAt": 123,
      "expired": true,
      "projects": {},
      "entitlements": [
        "<string>"
      ]
    }
  ],
  "pagination": {
    "hasNext": true,
    "count": 20,
    "next": 1540095775951,
    "prev": 1540095775951
  }
}

Authorizations

Authorization

string

header

required

Default authentication mechanism

Query Parameters

limit

number

Limit how many teams should be returned

Required range: x >= 1

Example:

20

since

number

Timestamp in milliseconds to only include members added since then.

Example:

1540095775951

until

number

Timestamp in milliseconds to only include members added until then.

Example:

1540095775951

string

Search team members by their name, username, and email.

role

enum<string>

Only return members with the specified team role.

Available options:

OWNER,

MEMBER,

DEVELOPER,

VIEWER,

BILLING,

CONTRIBUTOR

Example:

"OWNER"

excludeProject

string

Exclude members who belong to the specified project.

eligibleMembersForProjectId

string

Include team members who are eligible to be members of the specified project.

Response

200

application/json

members

object[]

required

members.confirmed

boolean

required

Boolean that indicates if this member was confirmed by an owner.

Example:

true

members.email

string

required

The email of this member.

Example:

"jane.doe@example.com"

members.role

enum<string>

required

Role of this user in the team.

Available options:

OWNER,

MEMBER,

DEVELOPER,

VIEWER,

BILLING,

CONTRIBUTOR,

SECURITY

Example:

"OWNER"

members.uid

string

required

The ID of this user.

Example:

"zTuNVUXEAvvnNN3IaqinkyMw"

members.username

string

required

The unique username of this user.

Example:

"jane-doe"

members.createdAt

number

required

Timestamp in milliseconds when this member was added.

Example:

1588720733602

members.avatar

string

ID of the file for the Avatar of this member.

Example:

"123a6c5209bc3778245d011443644c8d27dc2c50"

members.github

object

Information about the GitHub account for this user.

members.gitlab

object

Information about the GitLab account of this user.

members.bitbucket

object

Information about the Bitbucket account of this user.

members.name

string

The name of this user.

Example:

"Jane Doe"

members.accessRequestedAt

number

Timestamp in milliseconds for when this team member was accepted by an owner.

Example:

1588820733602

members.joinedFrom

object

Map with information about the members origin if they joined by requesting access.

members.projects

object[]

Array of project memberships

pagination

object

required

emailInviteCodes

object[]

Remove System Bypass Rule Invite a user

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.teams.getTeamMembers({
    limit: 20,
    since: 1540095775951,
    until: 1540095775951,
    role: "OWNER",
  });

  // Handle the result
  console.log(result);
}

run();

{
  "members": [
    {
      "avatar": "123a6c5209bc3778245d011443644c8d27dc2c50",
      "confirmed": true,
      "email": "jane.doe@example.com",
      "github": {
        "login": "<string>"
      },
      "gitlab": {
        "login": "<string>"
      },
      "bitbucket": {
        "login": "<string>"
      },
      "role": "OWNER",
      "uid": "zTuNVUXEAvvnNN3IaqinkyMw",
      "username": "jane-doe",
      "name": "Jane Doe",
      "createdAt": 1588720733602,
      "accessRequestedAt": 1588820733602,
      "joinedFrom": {
        "origin": "teams",
        "commitId": "<string>",
        "repoId": "<string>",
        "repoPath": "<string>",
        "gitUserId": "<string>",
        "gitUserLogin": "<string>",
        "ssoUserId": "<string>",
        "ssoConnectedAt": 123,
        "idpUserId": "<string>",
        "dsyncUserId": "<string>",
        "dsyncConnectedAt": 123
      },
      "projects": [
        {
          "name": "<string>",
          "id": "<string>",
          "role": "ADMIN"
        }
      ]
    }
  ],
  "emailInviteCodes": [
    {
      "accessGroups": [
        "<string>"
      ],
      "id": "<string>",
      "email": "<string>",
      "role": "OWNER",
      "isDSyncUser": true,
      "createdAt": 123,
      "expired": true,
      "projects": {},
      "entitlements": [
        "<string>"
      ]
    }
  ],
  "pagination": {
    "hasNext": true,
    "count": 20,
    "next": 1540095775951,
    "prev": 1540095775951
  }
}

Endpoints

Authorizations

Query Parameters

Response