List team members - Vercel API Docs

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": [
    {
      "confirmed": true,
      "email": "jane.doe@example.com",
      "role": "OWNER",
      "uid": "zTuNVUXEAvvnNN3IaqinkyMw",
      "username": "jane-doe",
      "createdAt": 1588720733602,
      "avatar": "123a6c5209bc3778245d011443644c8d27dc2c50",
      "github": {
        "login": "<string>"
      },
      "gitlab": {
        "login": "<string>"
      },
      "bitbucket": {
        "login": "<string>"
      },
      "name": "Jane Doe",
      "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"
        }
      ]
    }
  ],
  "pagination": {
    "hasNext": true,
    "count": 20,
    "next": 1540095775951,
    "prev": 1540095775951
  },
  "emailInviteCodes": [
    {
      "id": "<string>",
      "isDSyncUser": true,
      "accessGroups": [
        "<string>"
      ],
      "email": "<string>",
      "role": "OWNER",
      "teamRoles": [
        "OWNER"
      ],
      "teamPermissions": [
        "IntegrationManager"
      ],
      "createdAt": 123,
      "expired": true,
      "projects": {},
      "entitlements": [
        "<string>"
      ]
    }
  ]
}

GET

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": [
    {
      "confirmed": true,
      "email": "jane.doe@example.com",
      "role": "OWNER",
      "uid": "zTuNVUXEAvvnNN3IaqinkyMw",
      "username": "jane-doe",
      "createdAt": 1588720733602,
      "avatar": "123a6c5209bc3778245d011443644c8d27dc2c50",
      "github": {
        "login": "<string>"
      },
      "gitlab": {
        "login": "<string>"
      },
      "bitbucket": {
        "login": "<string>"
      },
      "name": "Jane Doe",
      "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"
        }
      ]
    }
  ],
  "pagination": {
    "hasNext": true,
    "count": 20,
    "next": 1540095775951,
    "prev": 1540095775951
  },
  "emailInviteCodes": [
    {
      "id": "<string>",
      "isDSyncUser": true,
      "accessGroups": [
        "<string>"
      ],
      "email": "<string>",
      "role": "OWNER",
      "teamRoles": [
        "OWNER"
      ],
      "teamPermissions": [
        "IntegrationManager"
      ],
      "createdAt": 123,
      "expired": true,
      "projects": {},
      "entitlements": [
        "<string>"
      ]
    }
  ]
}

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,

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

members

object[]

required

Show child attributes

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,

SECURITY,

BILLING,

VIEWER,

VIEWER_FOR_PLUS,

CONTRIBUTOR

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.

Show child attributes

members.gitlab

object

Information about the GitLab account of this user.

Show child attributes

members.bitbucket

object

Information about the Bitbucket account of this user.

Show child attributes

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.

Show child attributes

members.joinedFrom.origin

enum<string>

required

Available options:

teams,

link,

mail,

import,

github,

gitlab,

bitbucket,

saml,

dsync,

feedback,

organization-teams

members.joinedFrom.commitId

string

members.joinedFrom.repoId

string

members.joinedFrom.repoPath

string

members.joinedFrom.gitUserId

members.joinedFrom.ssoUserId

string

members.joinedFrom.ssoConnectedAt

number

members.joinedFrom.idpUserId

string

members.joinedFrom.dsyncUserId

string

members.joinedFrom.dsyncConnectedAt

number

members.projects

object[]

Array of project memberships

Show child attributes

members.projects.name

string

required

members.projects.id

string

required

members.projects.role

enum<string>

Available options:

ADMIN,

PROJECT_DEVELOPER,

PROJECT_VIEWER

pagination

object

required

Show child attributes

pagination.hasNext

boolean

required

pagination.count

number

required

Amount of items in the current page.

Example:

20

pagination.next

number | null

required

Timestamp that must be used to request the next page.

Example:

1540095775951

pagination.prev

number | null

required

Timestamp that must be used to request the previous page.

Example:

1540095775951

emailInviteCodes

object[]

Show child attributes

emailInviteCodes.id

string

required

emailInviteCodes.isDSyncUser

boolean

required

emailInviteCodes.accessGroups

string[]

emailInviteCodes.email

string

emailInviteCodes.role

enum<string>

Available options:

OWNER,

MEMBER,

DEVELOPER,

SECURITY,

BILLING,

VIEWER,

VIEWER_FOR_PLUS,

CONTRIBUTOR

emailInviteCodes.teamRoles

enum<string>[]

Available options:

OWNER,

MEMBER,

DEVELOPER,

SECURITY,

BILLING,

VIEWER,

VIEWER_FOR_PLUS,

CONTRIBUTOR

emailInviteCodes.teamPermissions

enum<string>[]

Available options:

IntegrationManager,

CreateProject,

FullProductionDeployment,

UsageViewer,

EnvVariableManager,

EnvironmentManager,

V0Builder,

V0Chatter,

V0Viewer

emailInviteCodes.createdAt

number

emailInviteCodes.expired

boolean

emailInviteCodes.projects

object

Show child attributes

emailInviteCodes.projects.{key}

enum<string>

Available options:

ADMIN,

PROJECT_DEVELOPER,

PROJECT_VIEWER

emailInviteCodes.entitlements

string[]

Read Firewall Actions by Project Invite a user

⌘I

Endpoints

Authorizations

Query Parameters

Response