Authentication

​

API Key Authentication

​

Getting Your API Key

1

Log into your Upwell dashboard

Any member of your organization can create an API key.

2

Navigate to Account → API keys

If API keys isn’t visible in your navigation, it isn’t enabled for your organization yet — ask your Upwell administrator or support@upwell.com.

3

Click "Add API Key"

The key value is displayed once, at creation. Copy and store it securely — you can’t retrieve it again later, only revoke it and create a new one.

​

Key scope

• One key belongs to one Upwell organization (tenant) — the one it was created in. All data access through that key is scoped to that organization.
• Integrating with more than one Upwell customer? There is no cross-tenant credential: you hold one API key per customer, each created inside that customer’s own dashboard.
• Keys don’t expire. Rotation is manual: create a new key, switch your integration over, then revoke the old one.

​

Environments

• Keys are environment-specific. Each environment is a separate deployment with its own data, so a key created in your production dashboard authenticates only against api.upwell.com.
• Staging access is provisioned by Upwell, not self-serve — ask support@upwell.com or your Upwell contact to set up a staging organization and credentials for integration testing.

​

Using Your API Key

curl https://api.upwell.com/api/rest/invoices \
  -H "Authorization: YOUR_API_KEY"

curl https://api.upwell.com/api/rest/invoices \
  -H "Authorization: Bearer YOUR_API_KEY"

​

Example Requests

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

# Using requests
import requests

headers = {
    'Authorization': 'YOUR_API_KEY'
}

response = requests.get('https://api.upwell.com/api/rest/invoices', headers=headers)