Skip to main content

​
API Key Authentication

All API requests must include your API key in the X-API-Key header. 
-H "X-API-Key: sphud_abc12345_xxxxxxxxxxxxxxxxxxxxxxxx"

​
Getting an API Key

1

Log in to SPHUD

Sign in as an MSP Admin at dashboard.sphud.com
2

Navigate to MSP Settings

Click your profile icon and select “MSP Settings”
3

Find API Keys Section

Scroll to the “API Keys” section
4

Create New Key

Click “Create API Key” and give it a descriptive name
5

Copy and Store Securely

Copy your key immediately - it won’t be shown again!
Store your API key securely. Treat it like a password. If compromised, revoke it immediately and create a new one.

​
Example Request

curl -X GET "https://dashboard.sphud.com/api/external/customers" \
  -H "X-API-Key: sphud_abc12345_xxxxxxxxxxxxxxxxxxxxxxxx"

​
Error Responses

Status CodeDescription
401API key is missing, invalid, revoked, or expired
403API key doesn’t have permission for this operation
If you receive a 401 error, check that your API key is correctly formatted and hasn’t been revoked in settings.

​
Best Practices

Keep Keys Secure
  • Never commit API keys to version control
  • Use environment variables in your code
  • Rotate keys periodically
Use Descriptive Names
  • Name keys by their purpose: “N8N Production Sync”, “Dev Testing”
  • Makes it easier to manage and revoke specific integrations
Monitor Usage
  • Check your API key usage in settings
  • Revoke unused keys
  • Create separate keys for different integrations