teams

Get a Team

Changed on

Get information for the Team specified by the teamId parameter.

get/v2/teams/{teamId}

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v2/teams/{teamId}
  • Auth: HTTP bearer

Path parameters

teamIdstring required
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

Query parameters

slugstring
Example:my-team-url-slug

Response

The requested team

apiKeysInvalidatedAtnumber

Timestamp (ms) after which API keys created at or before this time are considered invalid for this team.

appTokensInvalidatedAtnumber

Timestamp (ms) after which Vercel App tokens created at or before this time are considered invalid for this team.

avatarstring nullable required

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

createdAtnumber required

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

creatorIdstring required

The ID of the user who created the Team.

defaultContinuousUsageKind'metered' | 'unmetered'

Default continuous-usage billing kind for projects under this team. Absent means projects stay unmetered.

descriptionstring nullable required

A short description of the Team.

disableRepositoryDispatchEventsfalse | true

Default for projects in the team. When true, projects in this team will not emit GitHub repository-dispatch events on deployment events unless the project explicitly overrides this setting via project.gitProviderOptions.disableRepositoryDispatchEvents.

disjunctiveProductionSecretPolicy'default' | 'off' | 'on' | 'null' nullable

Require production secrets to use a different value than preview or development.

dpAccessRequestsMode'all' | 'email-domain' | 'none'

Controls who can request access to protected deployments.

emailDomainstring nullable

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

enablePreviewFeedback'default' | 'default-force' | 'off' | 'off-force' | 'on' | 'on-force' | 'null' nullable

Whether toolbar is enabled on preview deployments

enableProductionFeedback'default' | 'default-force' | 'off' | 'off-force' | 'on' | 'on-force' | 'null' nullable

Whether toolbar is enabled on production deployments

hideIpAddressesfalse | true | null nullable

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

hideIpAddressesInLogDrainsfalse | true | null nullable

Indicates if IP addresses should be accessible in log drains

idstring required

The Team's unique identifier.

integrationTokensInvalidatedAtnumber

Timestamp (ms) after which integration tokens created at or before this time are considered invalid for this team.

inviteCodestring

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

limitedfalse required

Property indicating that this Team data contains full information. Limited Team data has limited: true.

namestring nullable required

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

orgRootTeamIdstring

Best-effort ID of the organization’s root billing team. When present, compare orgRootTeamId === id to identify the root team. It may be omitted even when parentId is set if organization resolution fails or the referenced organization is missing. Always omitted for non-organization teams.

parentIdstring

The organizationId for teams that belong to an organization (set on both the organization's root team and its child teams).

personalAccessTokensInvalidatedAtnumber

Timestamp (ms) after which personal access tokens created at or before this time are considered invalid for this team.

platformfalse | true

Whether the team is a platform team.

previewDeploymentSuffixstring nullable

The hostname that is current set as preview deployment suffix.

requireVerifiedCommitsfalse | true

When enabled, all projects in the team require commits to be signed and verified by the git provider before deployments will be created. Projects may override this via project.gitProviderOptions.requireVerifiedCommits (gated by Project:Update).

sensitiveEnvironmentVariablePolicy'default' | 'off' | 'on' | 'null' nullable

Sensitive environment variable policy for this team

slugstring required

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

stagingPrefixstring required

The prefix that is prepended to automatic aliases.

updatedAtnumber required

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

Example response

{
  "avatar": "6eb07268bcfadd309905ffb1579354084c24655c",
  "createdAt": 1630748523395,
  "creatorId": "R6efeCJQ2HKXywuasPDc0fOWB",
  "description": "Our mission is to make cloud computing accessible to everyone.",
  "emailDomain": "example.com",
  "id": "team_nllPyCtREAqxxdyFKbbMDlxd",
  "inviteCode": "hasihf9e89",
  "name": "My Team",
  "orgRootTeamId": "team_nllPyCtREAqxxdyFKbbMDlxd",
  "parentId": "org_nllPyCtREAqxxdyFKbbMDlxd",
  "platform": true,
  "previewDeploymentSuffix": "example.dev",
  "saml": {
    "connection": {
      "connectedAt": 1611796915677,
      "lastReceivedWebhookEvent": 1611796915677,
      "lastSyncedAt": 1611796915677,
      "state": "active",
      "type": "OktaSAML"
    },
    "directory": {
      "connectedAt": 1611796915677,
      "lastReceivedWebhookEvent": 1611796915677,
      "lastSyncedAt": 1611796915677,
      "state": "active",
      "type": "OktaSAML"
    }
  },
  "slug": "my-team",
  "updatedAt": 1611796915677
}

Changes