Skip to main content

Generate API Key from Mobile App

API keys allow you to integrate Habitify with other applications and services. You can generate and manage your API keys directly from the Habitify mobile app.

Prerequisites​

  • Habitify Premium subscription (API access is a premium feature)
  • Latest version of Habitify mobile app (v5.0+)
  • Active internet connection

Steps to Generate an API Key​

1. Open Settings​

Navigate to the Settings screen in your Habitify app:

  • iOS: Tap the gear icon in the top-right corner of the Home tab
  • Android: Open the navigation drawer and select Settings

2. Access Developer Settings​

  1. Scroll down to the Advanced section
  2. Tap on Developer Settings
  3. If prompted, authenticate using Face ID, Touch ID, or your device PIN

3. Generate New API Key​

  1. Tap the "Generate New API Key" button
  2. Configure your API key settings:
    • Name: Give your API key a descriptive name (e.g., "Zapier Integration")
    • API Version: Select v2 (recommended) or v1 for legacy integrations
    • Expiration: Choose expiration period or set to "Never expire"
    • Permissions: Select the scopes your integration needs

4. Copy and Secure Your API Key​

⚠️ Important: Your API key will only be displayed once. Make sure to:

  1. Tap "Copy API Key" to copy it to your clipboard
  2. Store it securely in a password manager
  3. Never share your API key publicly or commit it to version control

5. Test Your API Key​

You can test your API key using curl:

curl -X GET https://api.habitify.me/v2/habits \
  -H "X-API-Key: YOUR_API_KEY_HERE"

Managing API Keys​

View Active Keys​

  1. Go to Settings → Developer Settings → API Keys
  2. You'll see a list of all active API keys with:
    • Key name
    • Creation date
    • Last used date
    • Number of requests made

Revoke an API Key​

To revoke an API key:

  1. Navigate to your API keys list
  2. Swipe left on the key you want to revoke (iOS) or long-press (Android)
  3. Tap "Revoke"
  4. Confirm the action

⚠️ Note: Revoking a key immediately invalidates it. Any integrations using this key will stop working.

API Key Limits​

  • Free users: No API access
  • Premium users: Up to 5 active API keys
  • Team/Business users: Up to 20 active API keys

Security Best Practices​

  1. Use environment variables to store API keys in your applications
  2. Rotate keys regularly (recommended every 90 days)
  3. Use separate keys for different integrations
  4. Set expiration dates when possible
  5. Monitor usage through the Developer Settings dashboard

Troubleshooting​

"Developer Settings not available"​

  • Ensure you have an active Premium subscription
  • Update to the latest version of Habitify
  • Try logging out and back in

"Maximum API keys reached"​

  • Revoke unused API keys
  • Consider upgrading to a Team/Business plan for more keys

API key not working​

  • Verify the key was copied correctly
  • Check that the key hasn't expired
  • Ensure you're using the correct API version endpoint
  • Verify your subscription is still active

Rate Limits​

API keys are subject to the following rate limits:

  • 500 requests per minute
  • 50,000 requests per day

If you need higher limits, please contact support.

Need Help?​