Skip to main content

​
Base URL

​
Authentication

All requests require your API key in the x-flowla-api-key header. Generate API keys from your workspace under Settings → API.

​
Pagination

List endpoints accept page and limit query parameters.

​
Typical workflow

1

Create a room

POST /api/v2/rooms — optionally from a template or by duplicating an existing room.
2

Add sections

POST /api/v2/sections — create one or more sections in a single request.
3

Add pages

POST /api/v2/pages — create pages inside each section.
4

Add groups and blocks

POST /api/v2/groups then POST /api/v2/blocks — build page content.
5

Add action items

POST /api/v2/action-items — add action items to an action-plan block.
6

Automate

Register a webhook (FLOW_COMPLETED) or trigger workflows for follow-ups.

​
Endpoints

Rooms

Create, list, retrieve, and update rooms. Supports CRM linking and duplication.

Analytics

Rich engagement data per room: progress, assignees, section/step viewership.

Sections

Add and manage sections with access level control.

Pages

Add and organise pages within sections, with access levels.

Groups

Group blocks together on a page.

Blocks

Add text, images, links, embeds, PDFs, and action-plan blocks to groups.

Action Items

Create and manage action items with assignees, dates, and statuses.

Workflows

Trigger configured automations on a room.

Webhooks

Register and remove webhooks for room completion events.

Templates

List templates available in your org.

Companies

List and create companies to associate with rooms.

Users

List organization users.

Statuses

List room status definitions.