Skip to main content
The Postzee public API uses API key authentication. All endpoints require a valid API key sent in the Authorization header.

Base URL

Authentication

Include your API key in the Authorization header of every request:
Do not use the Bearer prefix. Send the API key directly as the header value.

Creating an API key

  1. Log in to Postzee
  2. Open the account drawer (click your avatar in the top-right)
  3. Go to SettingsAPI tab
  4. Click Create API Key
  5. Copy the key immediately — it will only be shown once

Requirements

  • A paid plan (Standard or higher) — the Free plan does not include API access
  • An active subscription — expired subscriptions cannot use the API
  • Account must not be blocked

Error responses

All error responses follow this format:

Testing your connection

Use the health check endpoint to verify your API key works:
Success response:

Available endpoints

See Rate Limits for request limits per endpoint.