🛠️

OpenAPI Spec

ActivePlatformMUSTFREE

What it does

Full OpenAPI 3.0 specification for the POTAL API, enabling auto-generated client libraries, interactive documentation, and API testing tools. Import into Postman, Swagger UI, or any OpenAPI-compatible tool.

How to use it

Download the spec

GET /api/v1/docs returns the OpenAPI 3.0 JSON specification for all endpoints.

Import into tools

Load the spec into Postman, Insomnia, or Swagger UI for interactive API exploration.

Generate clients

Use openapi-generator to create typed client libraries in any language.

Validate requests

Use the spec schemas to validate your request payloads before sending them.

API Reference

GET/api/v1/docs

Related Features

🛠️API Documentation

Interactive API docs with code examples in 5 languages

🛠️REST API

155+ API endpoints with consistent JSON responses

🛠️Versioned API

Stable v1 API with backward-compatible versioning strategy

🔗SDK (JavaScript)

Official JavaScript/TypeScript SDK published on npm

🔗SDK (Python)

Official Python SDK with sync and async client support

Having issues?

🐛 Report a Bug ❓ Ask a Question 💡 Suggest Improvement