GET
/
v3
/
teams
/
{teamId}
/
members
getTeamMembers
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",
  });

  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",
      "teamRoles": [
        "OWNER"
      ],
      "teamPermissions": [
        "IntegrationManager"
      ],
      "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

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,
SECURITY,
BILLING,
VIEWER,
VIEWER_FOR_PLUS,
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

The response is of type object.