Skip to main content

​
API Key Authentication

All requests to the Upwell API must be authenticated using your API key. The key should be included in the Authorization header of each request.
API Key Generation Screen

​
Getting Your API Key

  1. Log into your Upwell dashboard 2. Navigate to Settings → API Keys 3. Click “Generate New API Key” 4. Copy and securely store your API key
API keys are sensitive credentials. Never share your API key or commit it to version control. If your key is compromised, generate a new one immediately and revoke the old key.

​
Using Your API Key

Include your API key in the Authorization header of all API requests: 
curl https://api.upwell.com/api/rest/invoices \
  -H "Authorization: YOUR_API_KEY"

​
Example Requests

// Using fetch
fetch('https://api.upwell.com/api/rest/invoices', {
  headers: {
    Authorization: 'YOUR_API_KEY',
  },
});