Endpoints
- access-groups
- artifacts
- checks
- projects
- deployments
- domains
- dns
- logDrains
- edge-config
- user
- marketplace
- integrations
- authentication
- logs
- projectMembers
- environment
- rolling-release
- security
- teams
- webhooks
- aliases
- certs
teams
List all teams
Get a paginated list of all the Teams the authenticated User is a member of.
GET
/
v2
/
teams
Copy
import { Vercel } from "@vercel/sdk";
const vercel = new Vercel({
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await vercel.teams.getTeams({
limit: 20,
since: 1540095775951,
until: 1540095775951,
});
console.log(result);
}
run();
Copy
{
"teams": [
{
"connect": {
"enabled": true
},
"creatorId": "R6efeCJQ2HKXywuasPDc0fOWB",
"updatedAt": 1611796915677,
"emailDomain": "example.com",
"saml": {
"connection": {
"type": "OktaSAML",
"status": "linked",
"state": "active",
"connectedAt": 1611796915677,
"lastReceivedWebhookEvent": 1611796915677
},
"directory": {
"type": "OktaSAML",
"state": "active",
"connectedAt": 1611796915677,
"lastReceivedWebhookEvent": 1611796915677
},
"enforced": true,
"roles": {}
},
"inviteCode": "hasihf9e89",
"description": "Our mission is to make cloud computing accessible to everyone.",
"stagingPrefix": "<string>",
"resourceConfig": {
"concurrentBuilds": 123,
"edgeConfigSize": 123,
"edgeConfigs": 123,
"kvDatabases": 123,
"blobStores": 123,
"postgresDatabases": 123,
"buildEntitlements": {
"enhancedBuilds": true
}
},
"previewDeploymentSuffix": "example.dev",
"remoteCaching": {
"enabled": true
},
"enablePreviewFeedback": "default",
"enableProductionFeedback": "default",
"sensitiveEnvironmentVariablePolicy": "default",
"hideIpAddresses": true,
"hideIpAddressesInLogDrains": true,
"ipBuckets": [
{
"bucket": "<string>",
"supportUntil": 123
}
],
"id": "team_nllPyCtREAqxxdyFKbbMDlxd",
"slug": "my-team",
"name": "My Team",
"avatar": "6eb07268bcfadd309905ffb1579354084c24655c",
"membership": {
"uid": "<string>",
"entitlements": [
{
"entitlement": "<string>"
}
],
"teamId": "<string>",
"confirmed": true,
"confirmedAt": 123,
"accessRequestedAt": 123,
"role": "OWNER",
"teamRoles": [
"OWNER"
],
"teamPermissions": [
"CreateProject"
],
"createdAt": 123,
"created": 123,
"joinedFrom": {
"origin": "saml",
"commitId": "<string>",
"repoId": "<string>",
"repoPath": "<string>",
"gitUserId": "<string>",
"gitUserLogin": "<string>",
"ssoUserId": "<string>",
"ssoConnectedAt": 123,
"idpUserId": "<string>",
"dsyncUserId": "<string>",
"dsyncConnectedAt": 123
}
},
"createdAt": 1630748523395
}
],
"pagination": {
"count": 20,
"next": 1540095775951,
"prev": 1540095775951
}
}
Authorizations
Default authentication mechanism
Query Parameters
Maximum number of Teams which may be returned.
Example:
20
Timestamp (in milliseconds) to only include Teams created since then.
Example:
1540095775951
Timestamp (in milliseconds) to only include Teams created until then.
Example:
1540095775951
Response
200
application/json
A paginated list of teams.
Copy
import { Vercel } from "@vercel/sdk";
const vercel = new Vercel({
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await vercel.teams.getTeams({
limit: 20,
since: 1540095775951,
until: 1540095775951,
});
console.log(result);
}
run();
Copy
{
"teams": [
{
"connect": {
"enabled": true
},
"creatorId": "R6efeCJQ2HKXywuasPDc0fOWB",
"updatedAt": 1611796915677,
"emailDomain": "example.com",
"saml": {
"connection": {
"type": "OktaSAML",
"status": "linked",
"state": "active",
"connectedAt": 1611796915677,
"lastReceivedWebhookEvent": 1611796915677
},
"directory": {
"type": "OktaSAML",
"state": "active",
"connectedAt": 1611796915677,
"lastReceivedWebhookEvent": 1611796915677
},
"enforced": true,
"roles": {}
},
"inviteCode": "hasihf9e89",
"description": "Our mission is to make cloud computing accessible to everyone.",
"stagingPrefix": "<string>",
"resourceConfig": {
"concurrentBuilds": 123,
"edgeConfigSize": 123,
"edgeConfigs": 123,
"kvDatabases": 123,
"blobStores": 123,
"postgresDatabases": 123,
"buildEntitlements": {
"enhancedBuilds": true
}
},
"previewDeploymentSuffix": "example.dev",
"remoteCaching": {
"enabled": true
},
"enablePreviewFeedback": "default",
"enableProductionFeedback": "default",
"sensitiveEnvironmentVariablePolicy": "default",
"hideIpAddresses": true,
"hideIpAddressesInLogDrains": true,
"ipBuckets": [
{
"bucket": "<string>",
"supportUntil": 123
}
],
"id": "team_nllPyCtREAqxxdyFKbbMDlxd",
"slug": "my-team",
"name": "My Team",
"avatar": "6eb07268bcfadd309905ffb1579354084c24655c",
"membership": {
"uid": "<string>",
"entitlements": [
{
"entitlement": "<string>"
}
],
"teamId": "<string>",
"confirmed": true,
"confirmedAt": 123,
"accessRequestedAt": 123,
"role": "OWNER",
"teamRoles": [
"OWNER"
],
"teamPermissions": [
"CreateProject"
],
"createdAt": 123,
"created": 123,
"joinedFrom": {
"origin": "saml",
"commitId": "<string>",
"repoId": "<string>",
"repoPath": "<string>",
"gitUserId": "<string>",
"gitUserLogin": "<string>",
"ssoUserId": "<string>",
"ssoConnectedAt": 123,
"idpUserId": "<string>",
"dsyncUserId": "<string>",
"dsyncConnectedAt": 123
}
},
"createdAt": 1630748523395
}
],
"pagination": {
"count": 20,
"next": 1540095775951,
"prev": 1540095775951
}
}
Assistant
Responses are generated using AI and may contain mistakes.