Everything you need to build on, extend, and integrate with FlowOS — the operating system for your business.
FlowOS is a unified enterprise platform that combines ITSM, workflow automation, application building, database management, integrations, and analytics into a single operating layer for your business. This documentation covers the REST API, studio-by-studio developer guides, authentication, webhooks, and SDK reference — everything you need to automate, extend, and integrate.
New here? Start with Getting Started to authenticate and make your first API call in under 5 minutes. Then read Core Concepts to understand how workspaces, environments, and entities work across the platform.
Platform Overview
FlowOS is organized into studios — each a purpose-built environment for a specific domain. All studios share a common data layer, authentication system, audit log, and REST API. Every action taken in the UI is available via the API.
Workflow Studio
Build process automations with a visual canvas. Trigger from schedules, webhooks, record events, or API calls.
App Studio
Create internal portals, admin panels, and dashboards with a visual builder or Monaco code editor.
DB Studio
Model data schemas, run SQL queries, manage migrations, and browse records through a rich UI and REST API.
Build and publish reusable JavaScript/TypeScript artifacts, packs, and modules across your organization.
Analytics Studio
Build live dashboards, KPI scorecards, and custom reports from any data source in the platform.
ITSM Core
Full ITIL-aligned incident, problem, change, service catalog, CMDB, SLA, and knowledge management.
REST API
Every platform resource is accessible via a consistent REST API with JSON responses and cursor-based pagination.
Webhooks & Events
Subscribe to platform events and receive real-time POST payloads to any URL you control.
Multi-Tenant
Every resource is scoped to a workspace. All API calls require a workspace context via header or token.
Base URL
All API requests are made to your instance base URL:
https://{your-instance}.flowos.io/api
If you are running FlowOS self-hosted, replace the domain with your own. All examples in this documentation use https://acme.flowos.io as the example instance.
FlowOS exposes a standard REST API — any HTTP client works. Official SDK wrappers are provided for common runtimes:
Node.js / TypeScript
npm install @flowos/sdk
Python
pip install flowos-sdk
The REST API is the primary interface. SDK wrappers are thin convenience layers that handle authentication headers, pagination, and error parsing — all examples in this documentation use raw HTTP to keep things language-agnostic.