API Overview

The WhenToMeet API provides programmatic access to create and manage scheduling events. This page covers prerequisites and essentials—for complete endpoint documentation, request/response schemas, and interactive testing, visit the API Reference.

Quick Start

1. Get API Access

The API requires a Plus or Plus Lifetime subscription.

View pricing →

2. Create an API Key

  1. Go to Settings → API Keys
  2. Click "Create API Key"
  3. Give it a descriptive name (e.g., "Production Server")
  4. Copy the key immediately—it's only shown once
  5. Store it securely (environment variables, secrets manager, etc.)

3. Explore the API

Visit the API Reference to:

  • Browse all available endpoints
  • View request/response schemas
  • Test API calls interactively
  • See code examples

Authentication

All requests require a Bearer token:

Authorization: Bearer sk_your_api_key_here

API Key Security

DO:

  • Store keys in environment variables or secrets managers
  • Use different keys for dev/staging/production
  • Rotate keys periodically
  • Revoke compromised keys immediately

DON'T:

  • Commit keys to version control
  • Share keys via email or chat
  • Embed keys in client-side code
  • Reuse keys across multiple applications

Rate Limits

TierLimitWindow
Free32 requestsLifetime total
Plus1,000 requestsPer hour (rolling)
Plus Lifetime1,000 requestsPer hour (rolling)

Rate Limit Headers

Responses include:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 847
X-RateLimit-Reset: 1736956800

When rate limited (429 response):

  • Implement exponential backoff
  • Check X-RateLimit-Reset for reset time
  • Monitor X-RateLimit-Remaining to throttle proactively

Need Help?

Was this page helpful?