An Access Token is required in order to use the Vercel API. Tokens can be created and managed at the level of your account.
Last updated on March 15, 2023
API & CLI
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.
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.
Once your token has been created, you can use it with the Vercel API. For example:
/v6/deployments
. The access token token you created would need access to your Personal Account.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"
Request to list the deployments of your Personal Account using curl.
const result = await fetch(
'https://api.vercel.com/v6/deployments',
Authorization: `Bearer ${process.env.VERCEL_ACCESS_TOKEN}`,
Request to list the deployments in your Personal Account.
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}`,
Authorization: `Bearer ${process.env.VERCEL_ACCESS_TOKEN}`,
Request to list the deployments in your Team.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4