Kernel docs API & MCP
API & MCP
Live, v1.0

The public API and MCP server are live.

Versioned REST API, 177 operations across 26 domains, reads and writes. Hosted MCP server. Key or JWT auth. Live reference below.

Public REST API

api.freelance-os.fr, versioned /v1. 177 operations across 26 domains, reads and writes. Auth via X-API-Key (partners, scripts, mobile) or session JWT (web and mobile). Keys are workspace-scoped automatically, otherwise the workspace goes in the {workspaceId} path. Responses are { data }, errors are typed with a stable code. OpenAPI 3.1 spec and live interactive reference at api.freelance-os.fr/v1/docs.

  • CRM: contacts, deals, segments, 360 view, interactions
  • Workbench: projects, tasks, milestones, KPIs
  • Counsel: quotes, contracts, invoices and line items
  • Booking and aggregated calendar: day agenda, week and month view
  • Inbox: threads, messages, conversations
  • Studio, Collections, Programme, Products, Analytics
  • Email, Calls, Webinars, LinkedIn, AI Visibility, Copilot
  • Identity, public plans, API key management

Reliability: idempotency, pagination, rate limit

Built for mobile and native clients on flaky networks. Send an Idempotency-Key header on your POST, PATCH and DELETE: a retry replays the same response instead of creating a duplicate. Large lists (contacts, records, inbox, calls) paginate by cursor: pass cursor and read pagination.next_cursor until has_more is false. 120 req/min sliding-window rate limit, X-RateLimit-* headers on every response.

  • Idempotency-Key: retry dedup, 409 if the same call is already in flight
  • Keyset cursor pagination: { data, pagination: { next_cursor, has_more } }
  • Rate limit 120 req/min, 429 when exceeded

MCP server

A hosted Model Context Protocol server. Wire Freelance OS to Claude Code, Cursor, ChatGPT, Claude Desktop in one command from /settings/mcp. 200+ tools, OAuth 2.1 + DCR, JIT approval on destructive actions, per-workspace audit log.

  • Full-text search across all modules
  • Draft creation from the agent
  • Read call transcripts
  • Mutate deals and tasks
  • Orchestrated multi-module workflows

API keys

Generate long-lived workspace-scoped keys from /settings/api-keys. Format fos_sk_live_<token>, sha256-hashed at rest, scopes (read:* / write:* / *), optional expiration. The plaintext shows once.

Webhooks

Roadmap Q3 2026. Set target URLs per workspace, pick the events you want. Signed payloads. Exponential retry. Event logs visible in /settings/webhooks.

  • contact.lifecycle_stage_changed
  • deal.stage_changed
  • invoice.paid
  • booking.created
  • draft.published

Connect your site

Wire any external site to a Freelance OS form without rebuilding a backend. Publish the form, add your site domain to the form's allowed origins, then copy the two snippets from the form page: the POST to /api/forms/submit (leads land in the CRM, the internal-notify and prospect-confirmation actions run inside FOS) and the px.js pixel for tracking. Each form is workspace-scoped, and so is the CORS allowlist: two workspaces never see each other.

  • Allowed origins: form editor, settings, domains
  • Submit snippet + pixel: the form page, copy-paste
  • GET /api/forms/schema?formId=... returns the field shape (id, label, type, options)
  • Check your mapping at your site build to block any form drift

SDK

Auto-generated TypeScript client from the OpenAPI spec, end-to-end typed. For other languages, use the OpenAPI 3.1 spec at api.freelance-os.fr/v1/openapi.json with your preferred generator.

Need help?

Keys, scopes, webhooks, partner integration, we help you directly. Book a slot.

Free plan. 60 seconds. No CC required.