GET
/
v10
/
projects
import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.projects.getProjects({
    gitForkProtection: "1",
    repoUrl: "https://github.com/vercel/next.js",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  // Handle the result
  console.log(result);
}

run();
{
  "projects": [
    {
      "accountId": "<string>",
      "analytics": {
        "id": "<string>",
        "canceledAt": 123,
        "disabledAt": 123,
        "enabledAt": 123,
        "paidAt": 123,
        "sampleRatePercent": 123,
        "spendLimitInDollars": 123
      },
      "speedInsights": {
        "id": "<string>",
        "enabledAt": 123,
        "disabledAt": 123,
        "canceledAt": 123,
        "hasData": true,
        "paidAt": 123
      },
      "autoExposeSystemEnvs": true,
      "autoAssignCustomDomains": true,
      "autoAssignCustomDomainsUpdatedBy": "<string>",
      "buildCommand": "<string>",
      "commandForIgnoringBuildStep": "<string>",
      "connectConfigurationId": "<string>",
      "connectBuildsEnabled": true,
      "createdAt": 123,
      "customerSupportCodeVisibility": true,
      "crons": {
        "enabledAt": 123,
        "disabledAt": 123,
        "updatedAt": 123,
        "deploymentId": "<string>",
        "definitions": [
          {
            "host": "vercel.com",
            "path": "/api/crons/sync-something?hello=world",
            "schedule": "0 0 * * *"
          }
        ]
      },
      "dataCache": {
        "userDisabled": true,
        "storageSizeBytes": 123,
        "unlimited": true
      },
      "deploymentExpiration": {
        "expirationDays": 123,
        "expirationDaysProduction": 123,
        "expirationDaysCanceled": 123,
        "expirationDaysErrored": 123,
        "deploymentsToKeep": 123
      },
      "devCommand": "<string>",
      "directoryListing": true,
      "installCommand": "<string>",
      "env": [
        {
          "target": [
            "production"
          ],
          "type": "system",
          "sunsetSecretId": "<string>",
          "id": "<string>",
          "key": "<string>",
          "value": "<string>",
          "configurationId": "<string>",
          "createdAt": 123,
          "updatedAt": 123,
          "createdBy": "<string>",
          "updatedBy": "<string>",
          "gitBranch": "<string>",
          "edgeConfigId": "<string>",
          "edgeConfigTokenId": "<string>",
          "contentHint": {
            "type": "redis-url",
            "storeId": "<string>"
          },
          "internalContentHint": {
            "type": "flags-secret",
            "encryptedValue": "<string>"
          },
          "decrypted": true,
          "comment": "<string>",
          "customEnvironmentIds": [
            "<string>"
          ],
          "vsmValue": "<string>"
        }
      ],
      "customEnvironments": [
        {}
      ],
      "framework": "blitzjs",
      "gitForkProtection": true,
      "gitLFS": true,
      "id": "<string>",
      "ipBuckets": [
        {
          "bucket": "<string>",
          "supportUntil": 123
        }
      ],
      "latestDeployments": [
        {
          "id": "<string>",
          "alias": [
            "<string>"
          ],
          "aliasAssigned": 123,
          "aliasError": {
            "code": "<string>",
            "message": "<string>"
          },
          "aliasFinal": "<string>",
          "automaticAliases": [
            "<string>"
          ],
          "branchMatcher": {
            "type": "endsWith",
            "pattern": "<string>"
          },
          "buildingAt": 123,
          "builds": [
            {
              "use": "<string>",
              "src": "<string>",
              "dest": "<string>"
            }
          ],
          "checksConclusion": "succeeded",
          "checksState": "registered",
          "connectBuildsEnabled": true,
          "connectConfigurationId": "<string>",
          "createdAt": 123,
          "createdIn": "<string>",
          "creator": {
            "email": "<string>",
            "githubLogin": "<string>",
            "gitlabLogin": "<string>",
            "uid": "<string>",
            "username": "<string>"
          },
          "deletedAt": 123,
          "deploymentHostname": "<string>",
          "forced": true,
          "name": "<string>",
          "meta": {},
          "monorepoManager": "<string>",
          "oidcTokenClaims": {
            "iss": "<string>",
            "sub": "<string>",
            "scope": "<string>",
            "aud": "<string>",
            "owner": "<string>",
            "owner_id": "<string>",
            "project": "<string>",
            "project_id": "<string>",
            "environment": "<string>"
          },
          "plan": "pro",
          "previewCommentsEnabled": false,
          "private": true,
          "readyAt": 123,
          "readyState": "BUILDING",
          "readySubstate": "STAGED",
          "requestedAt": 123,
          "target": "<string>",
          "teamId": "<string>",
          "type": "LAMBDAS",
          "url": "<string>",
          "userId": "<string>",
          "withCache": true
        }
      ],
      "link": {
        "org": "<string>",
        "repoOwnerId": 123,
        "repo": "<string>",
        "repoId": 123,
        "type": "github",
        "createdAt": 123,
        "deployHooks": [
          {
            "createdAt": 123,
            "id": "<string>",
            "name": "<string>",
            "ref": "<string>",
            "url": "<string>"
          }
        ],
        "gitCredentialId": "<string>",
        "updatedAt": 123,
        "sourceless": true,
        "productionBranch": "<string>"
      },
      "microfrontends": {
        "updatedAt": 123,
        "groupIds": [
          "<string>"
        ],
        "enabled": true,
        "isDefaultApp": true,
        "defaultRoute": "<string>",
        "routeObservabilityToThisProject": true
      },
      "name": "<string>",
      "nodeVersion": "22.x",
      "optionsAllowlist": {
        "paths": [
          {
            "value": "<string>"
          }
        ]
      },
      "outputDirectory": "<string>",
      "passiveConnectConfigurationId": "<string>",
      "passwordProtection": {},
      "productionDeploymentsFastLane": true,
      "publicSource": true,
      "resourceConfig": {
        "fluid": true,
        "functionDefaultRegions": [
          "<string>"
        ],
        "functionDefaultTimeout": 123,
        "functionDefaultMemoryType": "standard_legacy",
        "functionZeroConfigFailover": true,
        "elasticConcurrencyEnabled": true
      },
      "rollingRelease": {
        "target": "<string>",
        "minutesToRelease": 123,
        "stages": [
          {
            "targetPercentage": 123
          }
        ]
      },
      "defaultResourceConfig": {
        "fluid": true,
        "functionDefaultRegions": [
          "<string>"
        ],
        "functionDefaultTimeout": 123,
        "functionDefaultMemoryType": "standard_legacy",
        "functionZeroConfigFailover": true,
        "elasticConcurrencyEnabled": true
      },
      "rootDirectory": "<string>",
      "serverlessFunctionRegion": "<string>",
      "serverlessFunctionZeroConfigFailover": true,
      "skewProtectionBoundaryAt": 123,
      "skewProtectionMaxAge": 123,
      "skipGitConnectDuringLink": true,
      "sourceFilesOutsideRootDirectory": true,
      "enableAffectedProjectsDeployments": true,
      "ssoProtection": {
        "deploymentType": "preview"
      },
      "targets": {},
      "transferCompletedAt": 123,
      "transferStartedAt": 123,
      "transferToAccountId": "<string>",
      "transferredFromAccountId": "<string>",
      "updatedAt": 123,
      "live": true,
      "enablePreviewFeedback": true,
      "enableProductionFeedback": true,
      "permissions": {
        "user": [
          "create"
        ],
        "userConnection": [
          "create"
        ],
        "userSudo": [
          "create"
        ],
        "webAuthn": [
          "create"
        ],
        "oauth2Connection": [
          "create"
        ],
        "accessGroup": [
          "create"
        ],
        "aliasGlobal": [
          "create"
        ],
        "analyticsSampling": [
          "create"
        ],
        "analyticsUsage": [
          "create"
        ],
        "auditLog": [
          "create"
        ],
        "billingAddress": [
          "create"
        ],
        "billingInformation": [
          "create"
        ],
        "billingInvoice": [
          "create"
        ],
        "billingInvoiceEmailRecipient": [
          "create"
        ],
        "billingInvoiceLanguage": [
          "create"
        ],
        "billingPlan": [
          "create"
        ],
        "billingPurchaseOrder": [
          "create"
        ],
        "billingTaxId": [
          "create"
        ],
        "blob": [
          "create"
        ],
        "budget": [
          "create"
        ],
        "cacheArtifact": [
          "create"
        ],
        "cacheArtifactUsageEvent": [
          "create"
        ],
        "codeChecks": [
          "create"
        ],
        "concurrentBuilds": [
          "create"
        ],
        "connect": [
          "create"
        ],
        "connectConfiguration": [
          "create"
        ],
        "domain": [
          "create"
        ],
        "domainAcceptDelegation": [
          "create"
        ],
        "domainAuthCodes": [
          "create"
        ],
        "domainCertificate": [
          "create"
        ],
        "domainCheckConfig": [
          "create"
        ],
        "domainMove": [
          "create"
        ],
        "domainPurchase": [
          "create"
        ],
        "domainRecord": [
          "create"
        ],
        "domainTransferIn": [
          "create"
        ],
        "event": [
          "create"
        ],
        "ownEvent": [
          "create"
        ],
        "sensitiveEnvironmentVariablePolicy": [
          "create"
        ],
        "fileUpload": [
          "create"
        ],
        "flagsExplorerSubscription": [
          "create"
        ],
        "gitRepository": [
          "create"
        ],
        "ipBlocking": [
          "create"
        ],
        "imageOptimizationNewPrice": [
          "create"
        ],
        "integration": [
          "create"
        ],
        "integrationAccount": [
          "create"
        ],
        "integrationConfiguration": [
          "create"
        ],
        "integrationConfigurationTransfer": [
          "create"
        ],
        "integrationConfigurationProjects": [
          "create"
        ],
        "integrationVercelConfigurationOverride": [
          "create"
        ],
        "integrationConfigurationRole": [
          "create"
        ],
        "integrationSSOSession": [
          "create"
        ],
        "integrationResource": [
          "create"
        ],
        "integrationEvent": [
          "create"
        ],
        "integrationResourceSecrets": [
          "create"
        ],
        "integrationDeploymentAction": [
          "create"
        ],
        "marketplaceInstallationMember": [
          "create"
        ],
        "marketplaceBillingData": [
          "create"
        ],
        "marketplaceInvoice": [
          "create"
        ],
        "marketplaceExperimentationItem": [
          "create"
        ],
        "marketplaceExperimentationEdgeConfigData": [
          "create"
        ],
        "jobGlobal": [
          "create"
        ],
        "drain": [
          "create"
        ],
        "logDrain": [
          "create"
        ],
        "Monitoring": [
          "create"
        ],
        "monitoringSettings": [
          "create"
        ],
        "monitoringQuery": [
          "create"
        ],
        "monitoringChart": [
          "create"
        ],
        "monitoringAlert": [
          "create"
        ],
        "notificationDeploymentFailed": [
          "create"
        ],
        "notificationDomainConfiguration": [
          "create"
        ],
        "notificationDomainExpire": [
          "create"
        ],
        "notificationDomainMoved": [
          "create"
        ],
        "notificationDomainPurchase": [
          "create"
        ],
        "notificationDomainRenewal": [
          "create"
        ],
        "notificationDomainTransfer": [
          "create"
        ],
        "notificationDomainUnverified": [
          "create"
        ],
        "NotificationMonitoringAlert": [
          "create"
        ],
        "notificationPaymentFailed": [
          "create"
        ],
        "notificationUsageAlert": [
          "create"
        ],
        "notificationCustomerBudget": [
          "create"
        ],
        "notificationStatementOfReasons": [
          "create"
        ],
        "observabilityConfiguration": [
          "create"
        ],
        "openTelemetryEndpoint": [
          "create"
        ],
        "paymentMethod": [
          "create"
        ],
        "permissions": [
          "create"
        ],
        "postgres": [
          "create"
        ],
        "previewDeploymentSuffix": [
          "create"
        ],
        "proTrialOnboarding": [
          "create"
        ],
        "sharedEnvVars": [
          "create"
        ],
        "sharedEnvVarsProduction": [
          "create"
        ],
        "space": [
          "create"
        ],
        "spaceRun": [
          "create"
        ],
        "passwordProtectionInvoiceItem": [
          "create"
        ],
        "rateLimit": [
          "create"
        ],
        "redis": [
          "create"
        ],
        "repository": [
          "create"
        ],
        "remoteCaching": [
          "create"
        ],
        "samlConfig": [
          "create"
        ],
        "secret": [
          "create"
        ],
        "redisStoreTokenSet": [
          "create"
        ],
        "blobStoreTokenSet": [
          "create"
        ],
        "postgresStoreTokenSet": [
          "create"
        ],
        "integrationStoreTokenSet": [
          "create"
        ],
        "integrationResourceReplCommand": [
          "create"
        ],
        "storeTransfer": [
          "create"
        ],
        "supportCase": [
          "create"
        ],
        "supportCaseComment": [
          "create"
        ],
        "dataCacheBillingSettings": [
          "create"
        ],
        "team": [
          "create"
        ],
        "teamAccessRequest": [
          "create"
        ],
        "teamFellowMembership": [
          "create"
        ],
        "teamGitExclusivity": [
          "create"
        ],
        "teamInvite": [
          "create"
        ],
        "teamInviteCode": [
          "create"
        ],
        "teamJoin": [
          "create"
        ],
        "teamMicrofrontends": [
          "create"
        ],
        "teamOwnMembership": [
          "create"
        ],
        "teamOwnMembershipDisconnectSAML": [
          "create"
        ],
        "token": [
          "create"
        ],
        "usage": [
          "create"
        ],
        "usageCycle": [
          "create"
        ],
        "vpcPeeringConnection": [
          "create"
        ],
        "webAnalyticsPlan": [
          "create"
        ],
        "edgeConfig": [
          "create"
        ],
        "edgeConfigItem": [
          "create"
        ],
        "edgeConfigSchema": [
          "create"
        ],
        "edgeConfigToken": [
          "create"
        ],
        "webhook": [
          "create"
        ],
        "webhook-event": [
          "create"
        ],
        "endpointVerification": [
          "create"
        ],
        "projectTransferIn": [
          "create"
        ],
        "oauth2Application": [
          "create"
        ],
        "aliasProject": [
          "create"
        ],
        "aliasProtectionBypass": [
          "create"
        ],
        "productionAliasProtectionBypass": [
          "create"
        ],
        "connectConfigurationLink": [
          "create"
        ],
        "dataCacheNamespace": [
          "create"
        ],
        "deployment": [
          "create"
        ],
        "deploymentCheck": [
          "create"
        ],
        "deploymentCheckPreview": [
          "create"
        ],
        "deploymentCheckReRunFromProductionBranch": [
          "create"
        ],
        "deploymentProductionGit": [
          "create"
        ],
        "deploymentV0": [
          "create"
        ],
        "deploymentPreview": [
          "create"
        ],
        "deploymentPrivate": [
          "create"
        ],
        "deploymentPromote": [
          "create"
        ],
        "deploymentRollback": [
          "create"
        ],
        "environments": [
          "create"
        ],
        "logs": [
          "create"
        ],
        "logsPreset": [
          "create"
        ],
        "passwordProtection": [
          "create"
        ],
        "optionsAllowlist": [
          "create"
        ],
        "job": [
          "create"
        ],
        "observabilityData": [
          "create"
        ],
        "project": [
          "create"
        ],
        "projectFromV0": [
          "create"
        ],
        "projectAccessGroup": [
          "create"
        ],
        "projectAnalyticsSampling": [
          "create"
        ],
        "projectDeploymentHook": [
          "create"
        ],
        "projectDomain": [
          "create"
        ],
        "projectDomainMove": [
          "create"
        ],
        "projectDomainCheckConfig": [
          "create"
        ],
        "projectEnvVars": [
          "create"
        ],
        "projectEnvVarsProduction": [
          "create"
        ],
        "projectEnvVarsUnownedByIntegration": [
          "create"
        ],
        "projectFlags": [
          "create"
        ],
        "projectId": [
          "create"
        ],
        "projectIntegrationConfiguration": [
          "create"
        ],
        "projectLink": [
          "create"
        ],
        "projectMember": [
          "create"
        ],
        "projectMonitoring": [
          "create"
        ],
        "projectPermissions": [
          "create"
        ],
        "projectProductionBranch": [
          "create"
        ],
        "projectTransfer": [
          "create"
        ],
        "projectTransferOut": [
          "create"
        ],
        "projectProtectionBypass": [
          "create"
        ],
        "projectUsage": [
          "create"
        ],
        "projectAnalyticsUsage": [
          "create"
        ],
        "projectSupportCase": [
          "create"
        ],
        "projectSupportCaseComment": [
          "create"
        ],
        "projectDeploymentExpiration": [
          "create"
        ],
        "projectRollingRelease": [
          "create"
        ],
        "projectTier": [
          "create"
        ],
        "seawallConfig": [
          "create"
        ],
        "skewProtection": [
          "create"
        ],
        "analytics": [
          "create"
        ],
        "trustedIps": [
          "create"
        ],
        "webAnalytics": [
          "create"
        ],
        "sharedEnvVarConnection": [
          "create"
        ],
        "sonar": [
          "create"
        ]
      },
      "lastRollbackTarget": {},
      "lastAliasRequest": {
        "fromDeploymentId": "<string>",
        "toDeploymentId": "<string>",
        "jobStatus": "succeeded",
        "requestedAt": 123,
        "type": "promote"
      },
      "protectionBypass": {},
      "hasActiveBranches": true,
      "trustedIps": {
        "deploymentType": "production",
        "addresses": [
          {
            "value": "<string>",
            "note": "<string>"
          }
        ],
        "protectionMode": "additional"
      },
      "gitComments": {
        "onPullRequest": true,
        "onCommit": true
      },
      "gitProviderOptions": {
        "createDeployments": "enabled"
      },
      "paused": true,
      "concurrencyBucketName": "<string>",
      "webAnalytics": {
        "id": "<string>",
        "disabledAt": 123,
        "canceledAt": 123,
        "enabledAt": 123,
        "hasData": true
      },
      "security": {
        "attackModeEnabled": true,
        "attackModeUpdatedAt": 123,
        "firewallEnabled": true,
        "firewallUpdatedAt": 123,
        "attackModeActiveUntil": 123,
        "firewallConfigVersion": 123,
        "firewallRoutes": [
          {
            "src": "<string>",
            "has": [
              {
                "type": "path",
                "key": "<string>",
                "value": "<string>"
              }
            ],
            "missing": [
              {
                "type": "path",
                "key": "<string>",
                "value": "<string>"
              }
            ],
            "dest": "<string>",
            "status": 123,
            "handle": "init",
            "mitigate": {
              "action": "deny",
              "rule_id": "<string>",
              "ttl": 123,
              "erl": {
                "algo": "fixed_window",
                "window": 123,
                "limit": 123,
                "keys": [
                  "<string>"
                ]
              }
            }
          }
        ],
        "firewallSeawallEnabled": true,
        "ja3Enabled": true,
        "ja4Enabled": true,
        "firewallBypassIps": [
          "<string>"
        ],
        "managedRules": {}
      },
      "oidcTokenConfig": {
        "enabled": true,
        "issuerMode": "team"
      },
      "tier": "standard"
    }
  ],
  "pagination": {
    "count": 20,
    "next": 1540095775951,
    "prev": 1540095775951
  }
}

Authorizations

Authorization
string
header
required

Default authentication mechanism

Query Parameters

from
string

Query only projects updated after the given timestamp

gitForkProtection
enum<string>

Specifies whether PRs from Git forks should require a team member's authorization before it can be deployed

Available options:
1,
0
Example:

"1"

limit
string

Limit the number of projects returned

Search projects by the name field

repo
string

Filter results by repo. Also used for project count

repoId
string

Filter results by Repository ID.

repoUrl
string

Filter results by Repository URL.

Example:

"https://github.com/vercel/next.js"

excludeRepos
string

Filter results by excluding those projects that belong to a repo

edgeConfigId
string

Filter results by connected Edge Config ID

edgeConfigTokenId
string

Filter results by connected Edge Config Token ID

deprecated
boolean
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

200
application/json

The paginated list of projects

projects
object[]
required
pagination
object
required

This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data.