What is a Vercel Personal Access Token (PAT)?

A Vercel Personal Access Token (PAT) is an alphanumeric string that acts as your API key, authenticating your programmatic requests to the Vercel API. It grants access to resources associated with your Vercel account.

How do I generate a Vercel Personal Access Token?

You can generate a PAT by logging into your Vercel dashboard, navigating to Personal Account Settings > Tokens, and clicking 'Create New'. Remember to copy the token immediately as it won't be shown again.

Is the Vercel CLI required to use the Vercel API?

No, the Vercel CLI is not strictly required, but it is highly recommended for ease of use and automated authentication. You can also make direct HTTP requests using any programming language or HTTP client like cURL.

What permissions does a Vercel Personal Access Token have by default?

By default, a newly generated Personal Access Token typically inherits the permissions of the user who created it, granting access to the user's projects and resources. It's advisable to review and set specific permissions if available for granular control.

Where should I store my Vercel Personal Access Token securely?

Your PAT should be treated like a password. Store it securely using environment variables, secret management services, or secure configuration files, and never hardcode it directly into your public-facing code or commit it to version control.

What if my Vercel Personal Access Token is compromised?

If your PAT is compromised, immediately revoke it from your Vercel dashboard in the Personal Account Settings > Tokens section. Then, generate a new token and update all systems or applications using the old token.

Vercel API Getting Started: Quickstart Guide & First Call (2026)

Getting started overview

Getting started with the Vercel API involves a sequence of steps designed to enable programmatic interaction with your Vercel projects and deployments. This guide focuses on the essential steps: account setup, obtaining API credentials, and making an initial authenticated API request. The Vercel API supports various operations, including creating deployments, managing projects, and configuring domains Vercel API documentation. While Vercel is often associated with frontend frameworks like Next.js, its API provides broader utility for automating development workflows across different programming languages and environments.

The primary method for authentication with the Vercel API is through Personal Access Tokens (PATs). These tokens act as bearer tokens, granting access to resources associated with your Vercel account. For command-line interactions, the Vercel CLI (Command Line Interface) is the recommended tool, simplifying the process of making API calls and managing deployments directly from your terminal Vercel CLI documentation. Alternatively, direct HTTP requests can be made using any HTTP client or programming language capable of sending requests and handling JSON responses. This flexibility allows integration into custom scripts, CI/CD pipelines, or backend services.

Here's a quick reference table outlining the key steps:

Step	What to do	Where to do it
1. Create Vercel Account	Sign up for a free Vercel account. The Hobby tier is available for personal projects.	Vercel Signup Page
2. Generate Personal Access Token	Create a new Personal Access Token (PAT) with appropriate permissions.	Vercel Account Tokens Settings
3. Install Vercel CLI (Optional but Recommended)	Install the Vercel CLI globally using npm.	Terminal: `npm i -g vercel`
4. Log in via CLI	Authenticate the Vercel CLI with your account.	Terminal: `vercel login`
5. Make First API Request	Use the Vercel CLI or an HTTP client to make an authenticated request, e.g., fetching project list.	Terminal (CLI) or preferred HTTP client (e.g., cURL, Postman)

Create an account and get keys

To begin using the Vercel API, you must first create a Vercel account. Vercel offers a free Hobby tier suitable for personal projects, which provides access to the platform's core features, including serverless functions and automatic Git deployments Vercel pricing plans. Navigate to the Vercel signup page and follow the prompts to register. You can sign up using an email address, GitHub, GitLab, or Bitbucket account. Using a Git provider simplifies future deployments as Vercel integrates directly with your repositories.

Once your account is set up, the next crucial step is to generate a Personal Access Token (PAT). A PAT serves as your API key, authenticating your requests to the Vercel API. To generate a PAT:

Log in to your Vercel account dashboard.
Navigate to the Personal Account Settings > Tokens section.
Click on the 'Create New' button.
Provide a descriptive name for your token (e.g., "API Integration Script").
(Optional, but recommended for security) Set an expiration date for the token.
Click 'Create Token'.

The generated token will be displayed once. Copy this token immediately, as it will not be shown again for security reasons. Treat your PAT like a password; keep it secure and avoid exposing it in public repositories or client-side code. If a token is compromised, revoke it from your Vercel dashboard and generate a new one.

For enhanced security and management of API keys, especially in team environments, consider using environment variables to store your PATs. This practice helps prevent sensitive information from being hardcoded into your applications or scripts. The Google Cloud documentation on API key best practices provides general guidance on securing API keys, which applies to Vercel PATs.

Your first request

After obtaining your Personal Access Token, you can make your first authenticated request to the Vercel API. This section demonstrates how to do this using both the Vercel CLI and a direct HTTP request with cURL.

Using the Vercel CLI

The Vercel CLI simplifies interactions with the Vercel platform and API. If you haven't already, install it globally via npm:

npm i -g vercel

Next, log in to your Vercel account through the CLI. This command will open a browser window for authentication:

vercel login

Once logged in, the CLI automatically handles authentication for subsequent commands. To make your first API request, you can list your Vercel projects:

vercel projects ls

This command internally calls the Vercel API's /v9/projects endpoint and displays a list of your projects, confirming your setup is correct.

Using direct HTTP request (cURL)

For direct API calls, you'll use your Personal Access Token in the Authorization header as a Bearer token. Replace YOUR_VERCEL_PAT with the token you generated. This example fetches a list of your Vercel projects:

curl -X GET \
  "https://api.vercel.com/v9/projects" \
  -H "Authorization: Bearer YOUR_VERCEL_PAT" \
  -H "Content-Type: application/json"

A successful response will return a JSON object containing an array of your Vercel projects, their IDs, names, and other metadata. If you have no projects, the projects array will be empty. This confirms that your PAT is valid and you can successfully authenticate with the Vercel API.

Common next steps

Once you've successfully made your first API request, you can explore more advanced functionalities provided by the Vercel API. Common next steps often involve automating deployment workflows or managing project resources programmatically.

Automating Deployments: You can use the Vercel API to trigger new deployments, check their status, and manage aliases. This is particularly useful for integrating Vercel into Continuous Integration/Continuous Deployment (CI/CD) pipelines, allowing automated builds and deployments upon code pushes or other events. Refer to the Vercel Deployments API documentation for specific endpoints.
Managing Project Settings: The API allows you to update project settings, environment variables, and domains associated with your projects. This enables dynamic configuration updates without manual intervention through the Vercel dashboard. The Vercel Projects API section details these capabilities.
Utilizing Serverless Functions: Vercel's platform is designed for serverless functions, and the API supports managing these functions. You can deploy new functions, update existing ones, and retrieve logs programmatically. This can be integrated into a backend service or a custom development environment.
Exploring Vercel Integrations: Vercel provides a marketplace of integrations that extend its functionality with third-party services. While the API allows direct interaction, understanding how these integrations work can inspire ways to automate your own workflows.
Developing with Vercel SDKs: For specific frontend frameworks, Vercel offers SDKs such as the Next.js SDK, SvelteKit SDK, and Remix SDK, which provide a more integrated developer experience for building applications on Vercel. These SDKs often abstract away direct API calls, offering framework-specific methods for common tasks.
Setting up Webhooks: Configure webhooks to receive notifications about events in your Vercel projects, such as deployment status changes. This allows you to build reactive systems that respond to Vercel events. For general principles on webhook security, consult the Twilio webhook security guide.

Troubleshooting the first call

Encountering issues during your first API call is common. Here are some troubleshooting steps for typical problems when interacting with the Vercel API:

Invalid Personal Access Token (PAT):
- Issue: You receive an authentication error (e.g., 401 Unauthorized or 403 Forbidden).
- Solution: Double-check that your PAT is correct and has not expired. Generate a new PAT if necessary and ensure it's included in the Authorization: Bearer YOUR_VERCEL_PAT header correctly.
Incorrect API Endpoint:
- Issue: You receive a 404 Not Found error or an unexpected response.
- Solution: Verify that you are using the correct API endpoint URL from the Vercel API documentation. API versions (e.g., /v9/projects) are important.
Missing or Incorrect Headers:
- Issue: The API returns an error related to content type or expects specific headers.
- Solution: Ensure you include the Content-Type: application/json header for requests with a JSON body, and the Authorization header for all authenticated requests.
Network Connectivity Issues:
- Issue: Requests time out or fail to connect.
- Solution: Check your internet connection and ensure no firewalls or proxies are blocking access to api.vercel.com.
Vercel CLI Login Issues:
- Issue: The vercel login command doesn't open a browser or fails.
- Solution: Ensure your default browser is correctly configured. Try running vercel logout and then vercel login again. If issues persist, refer to the Vercel CLI troubleshooting guide.
Rate Limiting:
- Issue: You receive a 429 Too Many Requests error.
- Solution: Vercel APIs have rate limits. If you're making many requests in a short period, implement exponential backoff or pause your requests to stay within limits. Details on rate limits are typically found in the Vercel Platform documentation.