Skip to main content

OpenAPI Specification

Interactive reference

Prefer to explore and test the API in your browser? The interactive API reference renders this exact specification with a built-in "try it" client.

The Frihet public API exposes a complete OpenAPI 3.1 specification at GET /openapi.yaml. The specification describes all available operations, their parameters, responses, and data models in a machine-readable format ready for client generators, tool-calling agents, and interactive API explorers.

How it works​

The specification is served in YAML format as text/yaml with a 1-hour cache from the public API endpoint. It covers the core product resources: invoices, expenses, deposits, clients, products, quotes, payments, recurring invoices, and exports. For each resource, it documents the GET/POST/PATCH/DELETE endpoints with typed request and response schemas.

There are three common ways to use it:

  • Generating SDK clients in any language (Python, Go, Java, Ruby, etc.) using OpenAPI Generator or equivalent tooling—ideal when you are not working in TypeScript or need a client in a language not covered by the official SDK.
  • Importing into Postman, Insomnia, or Bruno to get a ready-to-use collection for testing the API interactively.
  • Feeding tool-calling AI agents that discover available operations from the specification and construct API requests automatically.

Additionally, docs.frihet.io/openapi.json publishes the same specification so crawlers and agents can discover it directly from the documentation site without authenticating against the API. It is not a manually maintained copy: it is fetched from the public endpoint during every build of this documentation site, so it reflects the public API at build time.

The specification is kept in sync with the live implementation. If you encounter a production endpoint that is missing or a field whose type differs from the specification, please contact support so our engineering team can update it.

Configuration​

No configuration is required. The specification is public and does not require an API key to read. To authenticate against live API endpoints, you will need an API key—manage your keys under Integrations → API Keys.

See also​