Authentication & API Keys

Authentication Method

API key authentication is implemented using the x-api-key header. This method provides a simple and secure way to authenticate your requests.

Header Format

Include your API key in the request header as follows:

x-api-key: YOUR_API_KEY

Getting Your API Key

1. Log in to your LeadBoxer account
2. Navigate to the Integrations settings and Data section
3. Generate or copy your API key
4. Store your API key securely - treat it like a password

Making Authenticated Requests

Example Request (cURL)

curl -X GET "https://api.leadboxer.com/api/endpoint" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Keep Your API Key Safe

• Never expose your API key in client-side code, public repositories, or version control
• Store API keys in environment variables or secure configuration files
• Use different API keys for development, staging, and production environments

Error Responses

401 Unauthorized

Returned when the API key is missing, invalid, or expired.

{
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}

Solution: Verify that your API key is correct and included in the x-api-key header.

API Key Management

Viewing Your API Keys

Navigate to your account settings to view active API key

Support

If you encounter authentication issues or need assistance:

• Check the API status page
• Review the troubleshooting guide
• Contact support at [email protected]
• Visit our community forums for peer assistance