Learn how to call Vercel API endpoints to interact with Vercel resources like projects, deployments, environment variables, and teams from your integration.
Your integration calls Vercel API endpoints to interact with Vercel's platform. You receive an access token when a user installs your integration, which you use to authenticate API requests.
Common operations include:
- Read project information — Get project details, configuration, and deployment history
- Manage environment variables — Create, update, or delete environment variables for projects
- Trigger deployments — Programmatically deploy projects when external events occur
- Access team data — Get team member information and permissions
- Update installations — Send notifications or update installation status
Vercel also calls Partner API endpoints on your server to manage the integration lifecycle. See Native Integration Flows to understand how these APIs work together.
Authenticate requests to the Vercel API using a Bearer token. You receive this token during installation.
credentials field of the request body of the Upsert Installation call.All Vercel API endpoints use the following base URL:
https://api.vercel.comYou receive an access token when a user installs your integration. Vercel calls your Upsert Installation endpoint with the token in the credentials field.
Store this token securely. You'll use it to authenticate all requests to the Vercel API for that installation.
Example: Using the access token
Authorization: Bearer YOUR_ACCESS_TOKENUse installation endpoints to update status, send notifications, or retrieve installation details:
- Get Installation — Retrieve current installation status and configuration
- Update Installation — Send notifications to users or update installation metadata
- Get Member — Retrieve information about team members for access control or audit logs
Access project data to understand user configuration and manage resources:
- Get Projects — List all projects in an installation
- Get Project — Retrieve detailed project configuration
- Get Environment Variables — Read current environment variable configuration
- Select an endpoint from the sidebar to view implementation details
- Review Native Integration Flows to understand the complete integration lifecycle
- See the Partner API reference for endpoints Vercel calls on your server
- Learn about using the Integrations REST API for detailed guides on authentication, notifications, and billing