The Omnifox REST API: introduction and plan requirements
What the Omnifox REST API is, which plan you need (Crece and up), how to authenticate with the X-API-Key header, and where the docs live.
Watch this step in the video · Requirements: plan and permissions
What is the Omnifox REST API?
The REST API lets you read and create your workspace's data —contacts, conversations, messages, CRM, projects— from your own code or a no-code tool. It's the foundation for automating flows, syncing your CRM, or building custom integrations.
This guide covers the essentials to get started: plan requirements, authentication, and where the docs live.
Plan requirements
API access is a plan feature called API access. It's available from the Crece plan upward (Crece, Escala, and Exclusivo). The Lite and Conecta plans don't include it.
If your plan doesn't have it, the API keys section will be locked and any API call will respond with the code PLAN_API_ACCESS_REQUIRED.
Before you start
- Administrator role for the workspace.
- A plan with API access.
- An API key already created (see below).
Steps
1. Create your API key
- Go to Settings → API Keys → New API key.
- Give it a name, choose the workspace, an expiration date, and check only the scopes you need:
read:contacts,write:contacts,read:messages,write:messages,read:channels,read:crm,write:crm,read:projects,write:projects. - Copy the key right away — it's shown only once.
2. Authenticate your calls
Send the token in the Authorization: Bearer header on every request:
curl https://omnifox.io/api/v1/contacts \
-H "Authorization: Bearer YOUR_TOKEN_HERE"
3. Know the base URL
All endpoints live under /api/v1/. For example: /api/v1/contacts, /api/v1/conversations, /api/v1/messages.
4. Read the docs
The interactive reference is at omnifox.io/docs, and the OpenAPI spec at omnifox.io/api-docs/openapi.json to import into Postman or generate an SDK.
Verify it worked
A GET /api/v1/contacts call with a valid key returns 200 and JSON with your contacts. Responses are wrapped in { "success": true, "data": ... }.
If it doesn't work
PLAN_API_ACCESS_REQUIRED: your plan doesn't include API access. Upgrade to Crece or higher.401: theAuthorization: Bearerheader is missing, or the key expired or was revoked.403: the key lacks the scope needed for that endpoint; edit it and add the scope.404on an endpoint: remember the path is/api/v1/..., not/v1/....
Tips
- Create a separate key per integration and give it only the minimum scopes.
- To receive real-time events (new messages, etc.) use Webhooks instead of polling.
Related articles
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.