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:
- Access account and member data — Retrieve the account and team member information for an installation
- Send notifications — Create events to update users on integration status
- Handle billing — Submit usage data, create invoices, and report prepayment balances
- Manage resources — Import external resources and rotate their credentials
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_TOKENSelect an endpoint from the sidebar for full documentation. The available endpoints fall into four groups:
- Get Account Information — Retrieve the account associated with an installation
- Get Member Information — Look up a team member's role and permissions
- Create Event — Send a notification or status update to users of your integration
- Submit Billing Data — Report usage or subscription charges for an installation
- Submit Invoice — Create an invoice for billing
- Get Invoice — Retrieve an existing invoice
- Invoice Actions — Perform actions on an invoice, such as voiding or refunding
- Submit Prepayment Balances — Report prepaid credit balances
- Import Resource — Associate an existing external resource with a Vercel project
- Update Resource Secrets — Rotate the credentials or secrets for a resource
- 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