Introduction to the Habitify API
The Habitify API allows you to connect your Habitify account with other apps, tools, and services. It acts as a bridge, letting you build custom integrations, automate your habit tracking, or view your data in ways that go beyond the standard app features.
Whether you want to display your habits on a personal dashboard, sync data with a spreadsheet, or build a custom widget, the Habitify API provides the access you need.
Habitify API Documentation
For a complete technical reference on all available endpoints, parameters, and data models, please visit our official documentation:
Generate Your API Key
To start using the API, you need a unique code called an "API Key." This key acts like a password that authorizes your external tools to access your Habitify data safely.
Open the Habitify app on your phone.
Go to the Settings tab.
Tap on API Credentials.
Tap Generate New Key.
⚠️ Important Security Warning:
Once you tap "Generate," your new API Key will appear on the screen. You must copy and save this key immediately. For security reasons, Habitify does not store or display the key after you leave this screen.
Note on Generating a New Key
If you lose your key or suspect it has been compromised, you can follow the steps above to generate a new one. However, please remember:
The Old Key Will Stop Working: As soon as you generate a new key, the previous one is immediately invalidated.
Update Your Tools: Any scripts, shortcuts, or integrations using the old key will fail until you update them with the new one.
Frequently Asked Questions
Q: Why can't I find the API Key on the Web App?
A: Currently, API Key management is exclusive to the mobile application for security management. Please use your iOS or Android device to generate your key.
Q: I lost my API Key. Can you recover it for me?
A: No. Because the key is only shown once and not stored visibly, we cannot recover it. You simply need to go to Settings > API Credentials and generate a brand new key.
Q: I am getting an "Unauthorized" error.
A: This usually means your API Key is missing, incorrect, or expired.
Did you recently generate a new key? If so, the old one no longer works.
Make sure you copied the key exactly as shown without any extra spaces.