Get a Team

Get information for the Team specified by the teamId parameter.

GET /v2/teams/{teamId}

getTeam

TypeScript

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

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

async function run() {
  const result = await vercel.teams.getTeam({
    slug: "my-team-url-slug",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
  });

  console.log(result);
}

run();

200

{
  "creatorId": "R6efeCJQ2HKXywuasPDc0fOWB",
  "updatedAt": 1611796915677,
  "description": "Our mission is to make cloud computing accessible to everyone.",
  "stagingPrefix": "<string>",
  "id": "team_nllPyCtREAqxxdyFKbbMDlxd",
  "slug": "my-team",
  "name": "My Team",
  "avatar": "6eb07268bcfadd309905ffb1579354084c24655c",
  "membership": {
    "confirmed": true,
    "role": "OWNER",
    "createdAt": 123,
    "created": 123,
    "uid": "<string>",
    "entitlements": [
      {
        "entitlement": "<string>"
      }
    ],
    "teamId": "<string>",
    "accessRequestedAt": 123,
    "teamRoles": [
      "OWNER"
    ],
    "teamPermissions": [
      "IntegrationManager"
    ],
    "joinedFrom": {
      "origin": "link",
      "commitId": "<string>",
      "repoId": "<string>",
      "repoPath": "<string>",
      "gitUserId": "<string>",
      "gitUserLogin": "<string>",
      "ssoUserId": "<string>",
      "ssoConnectedAt": 123,
      "idpUserId": "<string>",
      "dsyncUserId": "<string>",
      "dsyncConnectedAt": 123
    }
  },
  "createdAt": 1630748523395,
  "connect": {
    "enabled": true
  },
  "emailDomain": "example.com",
  "saml": {
    "enforced": true,
    "connection": {
      "type": "OktaSAML",
      "status": "linked",
      "state": "active",
      "connectedAt": 1611796915677,
      "lastReceivedWebhookEvent": 1611796915677,
      "lastSyncedAt": 1611796915677
    },
    "directory": {
      "type": "OktaSAML",
      "state": "active",
      "connectedAt": 1611796915677,
      "lastReceivedWebhookEvent": 1611796915677,
      "lastSyncedAt": 1611796915677
    },
    "defaultRedirectUri": "vercel.com",
    "roles": {}
  },
  "inviteCode": "hasihf9e89",
  "defaultRoles": {
    "teamRoles": [
      "OWNER"
    ],
    "teamPermissions": [
      "IntegrationManager"
    ]
  },
  "resourceConfig": {
    "concurrentBuilds": 123,
    "elasticConcurrencyEnabled": true,
    "edgeConfigSize": 123,
    "edgeConfigs": 123,
    "kvDatabases": 123,
    "blobStores": 123,
    "postgresDatabases": 123,
    "buildEntitlements": {
      "enhancedBuilds": true
    }
  },
  "previewDeploymentSuffix": "example.dev",
  "platform": true,
  "disableHardAutoBlocks": 123,
  "remoteCaching": {
    "enabled": true
  },
  "defaultDeploymentProtection": {
    "passwordProtection": {
      "deploymentType": "<string>"
    },
    "ssoProtection": {
      "deploymentType": "<string>"
    }
  },
  "defaultExpirationSettings": {
    "expirationDays": 123,
    "expirationDaysProduction": 123,
    "expirationDaysCanceled": 123,
    "expirationDaysErrored": 123,
    "deploymentsToKeep": 123
  },
  "enablePreviewFeedback": "default",
  "enableProductionFeedback": "default",
  "sensitiveEnvironmentVariablePolicy": "default",
  "hideIpAddresses": true,
  "hideIpAddressesInLogDrains": true,
  "ipBuckets": [
    {
      "bucket": "<string>",
      "supportUntil": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

Default authentication mechanism

Path Parameters

teamId · string · required

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

Query Parameters

slug · string

Example:

"my-team-url-slug"

Response

200

application/json

The requested team

Data representing a Team.

creatorId · string · required

The ID of the user who created the Team.

Example:

"R6efeCJQ2HKXywuasPDc0fOWB"

updatedAt · number · required

Timestamp (in milliseconds) of when the Team was last updated.

Example:

1611796915677

description · string | null · required

A short description of the Team.

Example:

"Our mission is to make cloud computing accessible to everyone."

stagingPrefix · string · required

The prefix that is prepended to automatic aliases.

id · string · required

The Team's unique identifier.

Example:

"team_nllPyCtREAqxxdyFKbbMDlxd"

slug · string · required

The Team's slug, which is unique across the Vercel platform.

Example:

"my-team"

name · string | null · required

Name associated with the Team account, or null if none has been provided.

Example:

"My Team"

avatar · string | null · required

The ID of the file used as avatar for this Team.

Example:

"6eb07268bcfadd309905ffb1579354084c24655c"

membership · object · required

The membership of the authenticated User in relation to the Team.

Show child attributes

createdAt · number · required

UNIX timestamp (in milliseconds) when the Team was created.

Example:

1630748523395

connect · object

Show child attributes

emailDomain · string | null

Hostname that'll be matched with emails on sign-up to automatically join the Team.

Example:

"example.com"

saml · object

When "Single Sign-On (SAML)" is configured, this object contains information regarding the configuration of the Identity Provider (IdP).

Show child attributes

inviteCode · string

Code that can be used to join this Team. Only visible to Team owners.

Example:

"hasihf9e89"

defaultRoles · object

Default roles for the team.

Show child attributes

resourceConfig · object

Show child attributes

previewDeploymentSuffix · string | null

The hostname that is current set as preview deployment suffix.

Example:

"example.dev"

platform · boolean

Whether the team is a platform team.

Example:

true

disableHardAutoBlocks · number boolean

remoteCaching · object

Is remote caching enabled for this team

Show child attributes

defaultDeploymentProtection · object

Default deployment protection for this team null indicates protection is disabled

Show child attributes

defaultExpirationSettings · object

Default deployment expiration settings for this team

Show child attributes

enablePreviewFeedback · enum<string> | null

Whether toolbar is enabled on preview deployments

Available options: default, on, off, on-force, off-force, default-force

enableProductionFeedback · enum<string> | null

Whether toolbar is enabled on production deployments

Available options: default, on, off, on-force, off-force, default-force

sensitiveEnvironmentVariablePolicy · enum<string> | null

Sensitive environment variable policy for this team

Available options: default, on, off

hideIpAddresses · boolean | null

Indicates if IP addresses should be accessible in observability (o11y) tooling

hideIpAddressesInLogDrains · boolean | null

Indicates if IP addresses should be accessible in log drains

ipBuckets · object[]

Show child attributes