Timo Hub API Documentation

🚀 Getting Started

The Timo Hub API provides programmatic access to all platform features, enabling you to build custom integrations, automate workflows, and manage your account programmatically.

1. Generate an API Key

Go to your Settings page and generate a new API key. Your key will look like:

timo_live_abc123xyz789def456

⚠️ Important: Store your API key securely! It will only be shown once. Treat it like a password.

2. Authenticate Your Requests

Include your API key in the Authorization header of every request:

Authorization: Bearer timo_live_your_api_key_here

3. Make Your First Request

curl https://dashboard.scottmartin.tech/api/v1/account \
  -H "Authorization: Bearer timo_live_your_api_key"

💰 Pricing & Rate Limits

API access is billed separately and rate-limited based on your plan:

Free

$0/mo

1,000 calls/month

Perfect for testing

Starter API

$29/mo

5,000 calls/month

Side projects

Developer API

$99/mo

50,000 calls/month

Production apps

Business API

$299/mo

250,000 calls/month

High volume

Enterprise plans get unlimited API access with SLA guarantees. Contact us for custom pricing.

📚 API Reference

GET /api/v1/health No auth

Health check endpoint. Returns API status and version.

GET /api/v1/account

Get account information including email, plan, and status.

GET /api/v1/account/quota

Get current month's API quota usage including limit, used, and remaining calls.

GET /api/v1/usage/stats?period=30d

Get usage analytics for 7d, 30d, or 90d period.

Parameters: period (7d | 30d | 90d)

GET /api/v1/usage/forecast?days=30

Get predictive analytics and quota forecasting.

Parameters: days (7-90)

GET /api/v1/auth/keys

List all API keys for your account.

POST /api/v1/auth/keys

Create a new API key. Returns the full key (only shown once!).

Body: {"name": "My API Key"}

DELETE /api/v1/auth/keys/{keyId}

Revoke an API key permanently.

🧪 Try It Out

Test API endpoints right here in your browser:

API Key: Endpoint:

🔐 Rate Limit Headers

Every response includes rate limit information:

Header	Description	Example
`X-RateLimit-Limit`	Total calls allowed per month	5000
`X-RateLimit-Remaining`	Calls remaining this month	3421
`X-RateLimit-Reset`	Unix timestamp when limit resets	1707091200

When you exceed your rate limit, you'll receive a 429 Too Many Requests response.

📖 Client Libraries

Official SDKs coming soon for:

Python (pip install timohub)
JavaScript/Node (npm install @timohub/sdk)
CLI Tool (timohub-cli)

Until then, use standard HTTP clients like requests (Python), fetch (JavaScript), or curl.

💡 Use Cases

Custom Dashboards: Embed Timo Hub analytics in your own admin panels
Automated Alerting: Set up custom alerts based on quota usage
Team Provisioning: Automatically create teams for new clients
Usage Reporting: Pull daily usage data for internal BI systems
Multi-Account Management: Manage hundreds of accounts programmatically

📞 Support

Need help? Have questions?

📧 Email: [email protected]
📖 Full API Spec: OpenAPI YAML
🐛 Report bugs: Create an issue on GitHub