Skip to main content
All API requests require authentication using an API key (secret key). The API key is associated with a specific business and grants access to that business’s data.
The Developer API requires an active paid subscription. If your business does not have an active subscription, API requests will return a 403 Forbidden error.

Getting Your API Key

To get your API key:
  1. Log in to your account at https://app.useadam.io/auth/login
  2. Navigate to Settings
  3. Under Business Settings, select API
  4. Copy your Secret Key
Keep your API key confidential. Do not share it publicly or commit it to version control systems.

API Key Header

Include your API key in the request header:
  • X-API-Key: your_secret_key

Example Request

curl -X GET "https://api.useadam.io/v1/adam/auth/validate" \
  -H "X-API-Key: your_secret_key"

Validate Business

Validate your API key and retrieve basic business information.

Response

{
  "status": "success",
  "message": "Business validated successfully",
  "data": {
    "uuid": "business-uuid",
    "name": "Business Name",
    "email": "[email protected]",
    "logo": "https://example.com/logo.png",
    "currency": "USD",
    "country": "US",
    "timezone": "America/New_York"
  }
}

Error Responses

401 Unauthorized
object
{
  "status": "failed",
  "message": "Invalid API key. Please check your API key and try again."
}
403 Forbidden
object
{
  "status": "failed",
  "message": "Your business must have an active subscription to use the Developer API. Please upgrade your subscription to continue."
}