GET
/
v9
/
projects
/
{idOrName}
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vercel.com/v9/projects/{idOrName}', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
{
  "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"
}

Authorizations

Authorization
string
header
required

Default authentication mechanism

Path Parameters

idOrName
required

The unique project identifier or the project name

Query Parameters

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 project information
accountId
string
required
directoryListing
boolean
required
id
string
required
name
string
required
nodeVersion
enum<string>
required
Available options:
22.x,
20.x,
18.x,
16.x,
14.x,
12.x,
10.x,
8.10.x
resourceConfig
object
required
defaultResourceConfig
object
required
analytics
object
speedInsights
object
autoExposeSystemEnvs
boolean
autoAssignCustomDomains
boolean
autoAssignCustomDomainsUpdatedBy
string
buildCommand
string | null
commandForIgnoringBuildStep
string | null
connectConfigurationId
string | null
connectBuildsEnabled
boolean
createdAt
number
customerSupportCodeVisibility
boolean
crons
object
dataCache
object
deploymentExpiration
object | null
devCommand
string | null
installCommand
string | null
env
object[]
customEnvironments
object[]
framework
enum<string> | null
Available options:
blitzjs,
nextjs,
gatsby,
remix,
react-router,
astro,
hexo,
eleventy,
docusaurus-2,
docusaurus,
preact,
solidstart-1,
solidstart,
dojo,
ember,
vue,
scully,
ionic-angular,
angular,
polymer,
svelte,
sveltekit,
sveltekit-1,
ionic-react,
create-react-app,
gridsome,
umijs,
sapper,
saber,
stencil,
nuxtjs,
redwoodjs,
hugo,
jekyll,
brunch,
middleman,
zola,
hydrogen,
vite,
vitepress,
vuepress,
parcel,
fasthtml,
sanity-v3,
sanity,
storybook
gitForkProtection
boolean
gitLFS
boolean
ipBuckets
object[]
latestDeployments
object[]
microfrontends
object
optionsAllowlist
object | null
outputDirectory
string | null
passiveConnectConfigurationId
string | null
passwordProtection
object | null
productionDeploymentsFastLane
boolean
publicSource
boolean | null
rollingRelease
object | null
rootDirectory
string | null
serverlessFunctionRegion
string | null
serverlessFunctionZeroConfigFailover
boolean
skewProtectionBoundaryAt
number
skewProtectionMaxAge
number
sourceFilesOutsideRootDirectory
boolean
enableAffectedProjectsDeployments
boolean
ssoProtection
object | null
targets
object
transferCompletedAt
number
transferStartedAt
number
transferToAccountId
string
transferredFromAccountId
string
updatedAt
number
live
boolean
enablePreviewFeedback
boolean | null
enableProductionFeedback
boolean | null
permissions
object
lastRollbackTarget
object | null
lastAliasRequest
object | null
protectionBypass
object
hasActiveBranches
boolean
trustedIps
object
gitComments
object
gitProviderOptions
object
paused
boolean
concurrencyBucketName
string
webAnalytics
object
security
object
oidcTokenConfig
object
tier
enum<string>
Available options:
standard,
advanced,
critical