Official Omnifox SDKs for Node.js, Python and PHP

What the official Omnifox SDKs are, what you need to use them, and when an SDK is a better choice than calling the API with curl.

Aug 19, 2026

Watch this step in the video · Official SDKs: Node, Python and PHP

Omnifox publishes three official SDKs that wrap the REST API v1 so you don't have to build HTTP requests by hand:

All three are on version 0.4 and cover the whole platform: inbox, contacts, CRM, boards and projects, calendar and appointments, catalog, orders and quotes, broadcasts, workflows, webhooks, and reports.

What they solve

  • Authentication and retries. They set the Authorization: Bearer header and retry on their own on 429 (honoring Retry-After) and on transient 5xx errors.
  • Pagination. They walk long lists without you keeping track of pages or cursors.
  • Typed errors. Instead of a loose JSON blob, you get an exception with the code, the HTTP status, and the per-field errors.
  • Things the API requires that aren't obvious. For example, four endpoints require the workspace id inside the body even when the token is already pinned to one; the SDKs fill it in for you.

Requirements

  • A plan with API Access: available from Crece up (Crece, Escala, and Exclusivo). Lite, Impulsa, and Conecta don't include it.
  • An API key created in Settings → Development → API Keys.
  • Node.js 20 or higher for the Node SDK; Python 3.9 or higher for the Python one; PHP 8.1 or higher (with Composer) for the PHP one.

Installation

# Node.js
npm install @omnifox/sdk

# Python
pip install omnifox

# PHP
composer require omnifox/sdk

Important about the key

None of the SDKs reads environment variables on its own. The key always has to be passed to the constructor. If you store the token in OMNIFOX_API_KEY, you are the one who reads it and hands it to the client.

What the SDKs don't do

  • They don't upload files. Attachments travel as a URL or as a typed payload; a real upload is multipart and no SDK implements it.
  • They don't expose the Team module or Co-browse.
  • They don't replace webhooks: to find out about events in real time, receiving a webhook is still better than polling in a loop.

Tips

  • If you're only going to make two or three calls, curl or your language's HTTP client is enough. The SDK pays off when pagination, retries, and several modules are involved.
  • If what you want is for an AI assistant to operate on Omnifox, look at the MCP server: it requires no code.

Related articles

Was this helpful?

Related articles

Message us on WhatsApp