Overview

The PlanMan API is a RESTful web service that allows you to manage your PlanMan data programmatically. This guide provides comprehensive information on how to use the API, including authentication, available endpoints, rate limiting, and error handling.

Base URL

All API requests should be made to:

https://api.planman.app/api

Authentication

API Key Authentication

All API requests require authentication using an API key provided in the Authorization header.

Header Format:

• Header Name: Authorization
  

• Value: Your API key (GUID format)
  

• Required: Yes, for all endpoints
  

Your API key must be a valid GUID (Globally Unique Identifier) format. Obtain your API key from within your PlanMan account.

Rate Limiting

Rate Limit Policy

• Limit: 1,000 requests per hour per API key
  

• Algorithm: Sliding window (not fixed hourly periods)
  

Rate Limit Headers

Every API response includes the following headers to help you monitor your usage:

• X-RateLimit-Limit: Maximum requests allowed per hour (1000)
  

• X-RateLimit-Remaining: Number of requests remaining in current window
  

• X-RateLimit-Reset: Unix timestamp when the oldest request expires
  

Rate Limit Exceeded

When you exceed your rate limit:

• HTTP Status: 429 Too Many Requests
  

• Response Body: "Rate limit exceeded. Maximum 1000 requests per hour allowed."
  

• Additional Header: Retry-After - seconds until you can make requests again