[metadata]
color-scheme: dark light
description: An Access Token is required in order to use the Vercel API. Tokens can be created and managed at the level of your account.
googlebot: index, max-video-preview:-1, max-image-preview:large, max-snippet:-1
initiator-trace: 00-eb9a48526cfda1dd5b0c05b8dc48ebd7-10a09ed6c8112e11-01
og:description: An Access Token is required in order to use the Vercel API. Tokens can be created and managed at the level of your account.
og:image: https://vercel.com/api/docs-og?title=How%20do%20I%20use%20a%20Vercel%20API%20Access%20Token%3F&format=kb&sig=b87ea9d17d7d2dc463bb6ef6c059f527b71593430660e7422195d32b8f678080
og:image:alt: How do I use a Vercel API Access Token?
og:image:height: 628
og:image:width: 1200
og:title: How do I use a Vercel API Access Token? | Vercel Knowledge Base
og:type: article
og:url: https://vercel.com/kb/guide/how-do-i-use-a-vercel-api-access-token
robots: index, follow
theme-color: #0a0a0a
trace-attributes: {"next.appdir":true}
twitter:card: summary_large_image
twitter:description: An Access Token is required in order to use the Vercel API. Tokens can be created and managed at the level of your account.
twitter:image: https://vercel.com/api/docs-og?title=How%20do%20I%20use%20a%20Vercel%20API%20Access%20Token%3F&format=kb&sig=b87ea9d17d7d2dc463bb6ef6c059f527b71593430660e7422195d32b8f678080
twitter:image:alt: How do I use a Vercel API Access Token?
twitter:image:height: 628
twitter:image:width: 1200
twitter:title: How do I use a Vercel API Access Token? | Vercel Knowledge Base
viewport: width=device-width, initial-scale=1, maximum-scale=5

[canonical-links]
https://vercel.com/kb/guide/how-do-i-use-a-vercel-api-access-token

[document-links]
/home
AI Apps: /solutions/ai-apps
AI Gateway: /ai-gateway
AI Gateway: /docs/ai-gateway
AI Integrations: /docs/agent-resources/integrations-for-models
AI SDK: /ai-sdk
AI SDK: /docs/ai-sdk
APIs & SDKs: /docs/rest-api
About: /about
Academy: /academy
Acceptable Use Policy: /legal/acceptable-use-policy
Account Tokens page: https://vercel.com/account/tokens
Account: /docs/accounts
Agent Skills: https://skills.sh
All frameworks: /docs/frameworks
Articles: /i
Blog ↗: https://vercel.com/blog
Blog: /blog
Bot ID: /botid
Bot Management: /docs/bot-management
Bot Management: /security/bot-management
BotID: /docs/botid
CI/CD: /products/previews
CLI: /docs/cli
Careers: /careers
Changelog ↗: https://vercel.com/changelog
Changelog: /changelog
Chat SDK New: /chat
Commerce: /solutions/composable-commerce
Community ↗: https://community.vercel.com
Community: https://community.vercel.com
Compliance: /docs/security/compliance
Connect New: /connect
Container Registry: /docs/container-registry
Content Delivery: /cdn
Cookie Policy: /legal/cookie-policy
Customers: /customers
DPA: /legal/dpa
Delivery Network: /docs/cdn
Deployment Protection: /docs/deployment-protection
Deployments: /docs/deployments
Design Engineers: /solutions/design-engineering
Docs: /docs
Domains: /docs/domains
Domains: /domains
Enterprise: /enterprise
Events: /events
FastAPI: /docs/frameworks/backend/fastapi
Feature Flags: /docs/flags
Firewall: /docs/vercel-firewall
Flags SDK: /docs/flags/flags-sdk-reference
Fluid Compute: /fluid
Functions: /docs/functions
Getting Started: /docs/getting-started-with-vercel
GitHub: https://github.com/vercel
Help: /help
How do I change my Vercel avatar? Information on changing your Vercel avatar.: /kb/guide/how-do-i-change-my-vercel-avatar
How do I change my Vercel username? Information on changing your Vercel username.: /kb/guide/how-do-i-change-my-vercel-username
Instagram: https://www.instagram.com/vercel/
Integrations: /docs/integrations
Knowledge Base: /kb
Legal (all documents): /legal
LinkedIn: https://linkedin.com/company/vercel
Loading status…: https://vercel-status.com
Log In: /login
Marketing Sites: /solutions/marketing-sites
Marketplace: /marketplace
Microfrontends: /docs/microfrontends
Next.js: /frameworks/nextjs
Nitro: /docs/frameworks/backend/nitro
Nuxt: /docs/frameworks/full-stack/nuxt
Observability: /docs/observability
Observability: /products/observability
Open Source Program: /open-source-program
Partner Finder: /partners/solution-partners
Passport New: /passport
Platform Engineers: /solutions/platform-engineering
Platform Security: /security
Platforms: /solutions/multi-tenant-saas
Press: /press
Pricing: /pricing
Privacy Policy: /legal/privacy-policy
Queues SDK New: /docs/queues/sdk
Sandbox: /docs/sandbox
Sandbox: /sandbox
Shipped on Vercel: /shipped
Sign Up: /signup
Start deploying: /new
Startups: /startups
Status: https://vercel-status.com
Storage: /docs/storage
Streamdown: https://streamdown.ai
SvelteKit: /docs/frameworks/full-stack/sveltekit
Talk to an expert: /contact/sales
Tanstack Start: /docs/frameworks/full-stack/tanstack-start
Teams: /docs/rbac
Templates: /templates
Terms of Service: /legal/terms
Toolbar: /docs/vercel-toolbar
Trust Center: https://security.vercel.com
Turborepo: /solutions/turborepo
Vercel + AWS: /partners/aws
Vercel API endpoint: https://vercel.com/docs/api
Vercel API: https://vercel.com/docs/api
Vercel Access Tokens: https://vercel.com/docs/rest-api#introduction/api-basics/authentication
Vercel Agent: /agent
Vercel Agent: /docs/agent
Vercel Drop New: /drop
Vercel MCP: /docs/mcp
Vercel Plugin New: /plugin
Vercel SDK: /docs/rest-api/sdk
WAF: /security/web-application-firewall
Web Apps: /solutions/web-apps
Why has my account or deployment been paused? Learn why a Vercel account or deployment gets paused, from budget and usage limits to policy violations, and how to resume it.: /kb/guide/why-is-my-account-deployment-blocked
Workflow SDK New: /workflows
Workflow: /docs/workflows
Workflows: /workflows
X: https://x.com/vercel
YouTube: https://youtube.com/@VercelHQ
eve New: /eve
eve New: https://eve.dev/
token has been created: https://vercel.com/guides/how-do-i-use-a-vercel-api-access-token#how-to-create-the-token
v0 ↗: https://v0.app
v0: https://v0.app
xmcp: /docs/frameworks/backend/xmcp

[structured-data]
{"@context":"https://schema.org","@type":"TechArticle","author":[{"@type":"Person","image":"https://images.ctfassets.net/hjgychtc108g/3hhQfsrFD2hm42NRrN5C5H/7470c15d32c283a4c64478e10030e94f/ismaelrumzan.png","name":"Ismael Rumzan","worksFor":{"@type":"Organization","name":"Vercel"}}],"dateModified":"2025-11-10T13:17:51.756Z","datePublished":"2025-11-03T16:47:54.449Z","description":"An Access Token is required in order to use the Vercel API. Tokens can be created and managed at the level of your account.","headline":"How do I use a Vercel API Access Token?","image":{"@type":"ImageObject","height":"630","url":"https://vercel.com/api/docs-og?title=How%20do%20I%20use%20a%20Vercel%20API%20Access%20Token%3F&format=kb&sig=b87ea9d17d7d2dc463bb6ef6c059f527b71593430660e7422195d32b8f678080","width":"1200"},"keywords":"Account, Teams","publisher":{"@type":"Organization","name":"Vercel","url":"https://vercel.com"},"url":"https://vercel.com/kb/guide/how-do-i-use-a-vercel-api-access-token"}

[content]
How do I use a Vercel API Access Token? | Vercel Knowledge Base
Skip to content
Copy Logo as SVG
Copy Wordmark as SVG
Brand Guidelines
Docs
Build
Build with AI
AI Gateway
AI SDK
Sandbox
Container Registry
Workflow
Vercel Agent
v0
↗
Vercel MCP
AI Integrations
Deploy & scale
Deployments
CLI
Functions
Delivery Network
Storage
Integrations
Microfrontends
Domains
Operate & protect
Firewall
Observability
Feature Flags
Toolbar
Bot Management
BotID
Deployment Protection
Compliance
Learn
Resources
Changelog
↗
Blog
↗
Community
↗
Knowledge Base
APIs & SDKs
Templates
Getting Started
Ask AI
Log In
Sign Up
Build
Build with AI
AI Gateway
AI SDK
Sandbox
Container Registry
Workflow
Vercel Agent
v0
↗
Vercel MCP
AI Integrations
Deploy & scale
Deployments
CLI
Functions
Delivery Network
Storage
Integrations
Microfrontends
Domains
Operate & protect
Firewall
Observability
Feature Flags
Toolbar
Bot Management
BotID
Deployment Protection
Compliance
Learn
Resources
Changelog
↗
Blog
↗
Community
↗
Knowledge Base
APIs & SDKs
Templates
Getting Started
Ask AI
Sign Up
Log In
How do I use a Vercel API Access Token?
An Access Token is required in order to use the Vercel API. Tokens can be created and managed at the level of your account.
Ismael Rumzan
Knowledge Base
Guides
3 Nov 2025
2
min read
Copy URL
Copy Markdown
Copy
Vercel Access Tokens
are required to authenticate and use the
Vercel API
.
Tokens can be created and managed inside your account settings, and can be scoped to only allow access for specific Teams. This article covers how to create a token and use it with your account.
Copy link to heading
Creating an Access Token
Make sure that you are under
Personal Account
and not
Teams
in the dropdown at the top left in the Navigation bar. Navigate to the
Account Tokens page
, also found under the
Settings
area of your Personal Account.
Click
Create
to open the create token modal.
Enter a descriptive name and click
Create Token
.
Choose the scope of access for the token from the dropdown.
Make a note of the token created as it will
not be shown again
.
Copy link to heading
Using the Access Token in Personal Account API Calls
Once your
token has been created
, you can use it with the Vercel API. For example:
Identify the
Vercel API endpoint
you would like to call. For example, to list the deployments in your Personal Account, the endpoint is
/v6/deployments
. The access token token you created would need access to your Personal Account.
Make a request to
https://api.vercel.com/v6/deployments
using your access token as the Authorization header.
curl
"https://api.vercel.com/v6/deployments"
-H
"Authorization: Bearer TOKEN"
const
result
=
await
fetch
(
'https://api.vercel.com/v6/deployments'
,
{
method
:
'GET'
,
headers
:
{
Authorization
:
`
Bearer
${
process
.
env
.
VERCEL_ACCESS_TOKEN
}
`
,
}
}
)
;
Copy link to heading
Using the Access Token in Team API Calls
If you are trying to retrieve deployments for a team, you will need to append
?teamId=<your-team-id>
to the URL. Your Team ID can be found inside your team's general project settings on the dashboard.
You will also need to ensure the access token created has the correct scope for the Team.
const
teamId
=
'replace-me'
const
result
=
await
fetch
(
`
https://api.vercel.com/v6/deployments?teamId=
${
teamId
}
`
,
{
method
:
'GET'
,
headers
:
{
Authorization
:
`
Bearer
${
process
.
env
.
VERCEL_ACCESS_TOKEN
}
`
,
}
}
)
;
Related documentation
Account
Teams
More Account guides
Why has my account or deployment been paused?
Learn why a Vercel account or deployment gets paused, from budget and usage limits to policy violations, and how to resume it.
How do I change my Vercel avatar?
Information on changing your Vercel avatar.
How do I change my Vercel username?
Information on changing your Vercel username.
Ready to deploy?
Start deploying
Talk to an expert
Agent Stack
AI SDK
AI Gateway
Sandbox
Workflows
Connect
New
Passport
New
eve
New
Core Platform
CI/CD
Content Delivery
Fluid Compute
Observability
Security
Platform Security
WAF
Bot Management
Bot ID
Tools
Vercel Drop
New
Vercel Agent
Vercel Plugin
New
Agent Skills
Next.js
Domains
v0
Frameworks
eve
New
Nuxt
SvelteKit
Nitro
Turborepo
Tanstack Start
FastAPI
xmcp
All frameworks
SDKs
Vercel SDK
Workflow SDK
New
Flags SDK
Chat SDK
New
Queues SDK
New
Streamdown
Build
AI Apps
Web Apps
Marketing Sites
Platforms
Commerce
Platform Engineers
Design Engineers
Learn
Docs
Blog
Changelog
Knowledge Base
Academy
Articles
Community
Explore
Customers
Marketplace
Templates
Partner Finder
Vercel + AWS
Company
About
Careers
Press
Events
Startups
Shipped on Vercel
Open Source Program
Enterprise
Pricing
Help
Legal & Trust
Privacy Policy
Terms of Service
Cookie Policy
DPA
Acceptable Use Policy
Legal (all documents)
Trust Center
Status
Cookie Preferences
Social
GitHub
X
LinkedIn
YouTube
Instagram
Copy Markdown
Copy Markdown
Loading status…
Select a display theme:
system
light
dark
