Exploring the API with Swagger UI (/docs) and the OpenAPI file

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/data and code/message/details envelopes).
• Reusable schemas (Contact, Conversation, Message, Deal, Board, etc.) so you understand the shape of each resource.

Example: trying an endpoint from Swagger UI

1. Go to https://app.omnifox.io/docs.
2. Find the endpoint, e.g. GET /v1/contacts.
3. Click "Try it out", then paste your Bearer token into the authorize button (lock icon) at the top.
4. Fill in the parameters you want to test (tag, per_page, etc.) and execute.
5. Swagger UI shows you the equivalent curl command, 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.json directly 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.