Exploring the API with Swagger UI (/docs) and the OpenAPI file
How to use Omnifox's interactive API documentation to try out endpoints without writing code.
Watch this step in the video · The API documentation
Omnifox publishes interactive documentation for its entire REST API, generated from an OpenAPI file, where you can see every endpoint, its parameters, the request/response schema, and even try it live from your browser.
How to access it
- Interactive documentation (Swagger UI):
https://app.omnifox.io/docs - Raw OpenAPI file (JSON):
https://app.omnifox.io/api-docs/openapi.json
The OpenAPI file is useful for auto-generating a client/SDK with tools like openapi-generator, Postman, or Insomnia (import by URL).
What you'll find
- Every module: Contacts, Conversations and Messages, CRM, Projects/Boards, Calendar, Reports, Webhooks, Workflows, Broadcasts, Agents, Channels, Teams, Tags, and Snippets.
- The exact success and error response formats (the
success/dataandcode/message/detailsenvelopes). - Reusable schemas (
Contact,Conversation,Message,Deal,Board, etc.) so you understand the shape of each resource.
Example: trying an endpoint from Swagger UI
- Go to
https://app.omnifox.io/docs. - Find the endpoint, e.g.
GET /v1/contacts. - Click "Try it out", then paste your Bearer token into the authorize button (lock icon) at the top.
- Fill in the parameters you want to test (
tag,per_page, etc.) and execute. - Swagger UI shows you the equivalent
curlcommand, the final URL, and the real response from your workspace.
Tips
- Use the authorize button once per browser session — the token stays applied to every endpoint you try afterward.
- If you're building your own SDK, import
openapi.jsondirectly into Postman ("Import > Link") to keep the whole collection up to date without maintaining it by hand.
Troubleshooting
- "Try it out" returns 401: you haven't loaded the Bearer token into the authorize button, or the token has expired.
- The endpoint I need isn't there: the documentation covers
/api/v1/*; very new features may take a release cycle to show up in the public spec.
Related articles
-
How to connect integrations and external apps
Connect Omnifox with your favorite tools from the integrations catalog in just a few steps.
-
Integrations and API complete guide
Integrations and API in depth, in 30 chapters: API keys, real calls, signed webhooks, n8n, MCP and SDKs, all really working.
-
Connecting Omnifox to Azur, Siigo, Alegra, QuickBooks or another accounting system or ERP
Omnifox doesn't have a native connector for accounting systems or ERPs today. Here's how to connect them anyway with workflows, the HTTP node, n8n, Make, Zapier or the API, with examples.
-
Generate and use API keys and webhooks
Create API keys to access Omnifox programmatically and set up webhooks to receive real-time events.
-
Getting started with integrations (webhook / OAuth / API key)
Connect Omnifox with your other tools: what's available today, what's coming soon, and when to use a webhook, an OAuth connection or an API key.