App docs/API & MCP
API & MCP
Live, v1.0

The public API and MCP server are live.

Versioned REST API, 177 operations across 26 domains, read and write. Hosted MCP server. Auth by key or session token. Live reference below.

Public REST API

api.freelance-os.fr, versioned under /v1. 177 operations across 26 domains, read and write. Authenticate with an X-API-Key (partners, scripts, mobile) or a session token (web and mobile). With a key the workspace is inferred. Otherwise pass it in the {workspaceId} path. Responses come as { data } and every error has a stable code. OpenAPI 3.1 spec and interactive reference: 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: retries, pagination, rate limits

Built for mobile clients on flaky networks. Send an Idempotency-Key header on your POST, PATCH and DELETE calls: a retry replays the same response without creating a duplicate. Large lists (contacts, records, inbox, calls) use cursor pagination. Pass cursor and read pagination.next_cursor until has_more is false. Limit of 120 requests per minute, with X-RateLimit-* headers on every response.

  • Idempotency-Key: a retry creates no duplicate, 409 if the same call is still running
  • Keyset cursor pagination: { data, pagination: { next_cursor, has_more } }
  • Rate limit 120 req/min, 429 when exceeded

MCP server

A hosted MCP server. Connect Freelance OS to Claude Code, Cursor, ChatGPT or Claude Desktop with one command, from Settings > MCP. Over 200 tools and an OAuth 2.1 connection. Destructive actions ask for your approval. Each workspace has its 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 keys tied to a workspace from Settings > API keys. Format fos_sk_live_<token>, permissions (read:* / write:* / *) and optional expiry. The key is shown only once.

Webhooks

Planned for Q3 2026. Configure target URLs per workspace and choose the events to receive. Each delivery is signed and retried on failure. Event history will be 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, permissions, webhooks, partner integration: we help you directly. Book a slot.

Book a call