Overview

Kakiyo API uses API keys for authentication. All API requests must be authenticated using your API key in the Authorization header.

API Keys

API keys are 40-character strings that should be copied from dashboard

Obtaining an API Key

You can generate API keys from your Kakiyo dashboard:

  1. Log in to your Kakiyo dashboard
  2. Navigate to Team > API Keys
  3. Click Create New API Key
  4. Give your key a descriptive name (e.g., “Production”, “Development”, “Testing”)
  5. Copy your newly generated API key immediately, as you won’t be able to see it again

API keys grant access to your Kakiyo account and all associated data. Keep your keys secure and never share them publicly.

Using Your API Key

Include your API key in the Authorization header of all API requests:

Authorization: Bearer API_KEY

API Key Best Practices

  1. Never expose your API keys in client-side code, public repositories, or anywhere else that is publicly accessible.

  2. Use different keys for different environments (development, staging, production).

  3. Rotate your keys periodically for security. You can generate new keys and deprecate old ones from your dashboard.

  4. Set appropriate permissions for each key based on what it needs to access.

  5. Monitor API key usage to detect unusual patterns that might indicate a security breach.

Verifying Authentication

You can verify your API key is working correctly by making a simple request to the verification endpoint:

curl -X GET "https://api.kakiyo.com/v1/verify" \
  -H "Authorization: Bearer YOUR_API_KEY"

If successful, you’ll receive a response like:

{
  "status": "success",
  "message": "API key is valid"
}

Managing API Keys

You can manage your API keys from the Kakiyo dashboard:

  • View all active keys: See a list of all your active API keys and when they were last used
  • Create new keys: Generate new API keys with specific permissions
  • Delete keys: Revoke access for keys that are no longer needed or may have been compromised

Error Responses

If authentication fails, you’ll receive one of the following error responses:

Status CodeErrorDescription
401missing_api_keyNo API key was provided in the request
401invalid_api_key_formatThe API key format is invalid
401invalid_api_keyThe API key is not recognized
403subscription_inactiveYour subscription is inactive

Next Steps

Now that you understand how to authenticate with the Kakiyo API, you can proceed to make API calls to create campaigns, add prospects, and more.