Quick Start Guide

Welcome to FlowSync! This guide will help you set up your workspace and start collaborating in under 5 minutes.

1. Create Your Workspace

After signing up, you'll be prompted to create your first workspace. Give it a name and invite your team members via email.

// Example: Creating a workspace via API
const workspace = await flowsync.workspaces.create({
  name: "My Team",
  plan: "pro",
  members: ["alice@company.com", "bob@company.com"]
});

2. Create Your First Project

Projects are the primary organizational unit in FlowSync. Each project can contain tasks, documents, and workflows.

Navigate to your workspace and click + New Project. Choose from a template or start from scratch.

3. Connect Integrations

Head to Settings → Integrations to connect your tools. Most integrations require just one OAuth click.

// Example: Webhook configuration
{
  "url": "https://api.flowsync.io/webhooks",
  "events": ["task.created", "task.completed"],
  "secret": "whsec_..."
}

That's it! You're ready to start managing your workflow with FlowSync. Explore the sidebar for more detailed guides on each feature.

Introduction

The FlowSync API is organized around REST. It accepts JSON-encoded request bodies, returns JSON responses, and uses standard HTTP response codes.

Base URL

https://api.flowsync.io/v1

Authentication

Authenticate requests with an API key using the Authorization header:

curl https://api.flowsync.io/v1/workspaces \
  -H "Authorization: Bearer fs_live_abc123..." \
  -H "Content-Type: application/json"

List Tasks

GET /v1/projects/:project_id/tasks

// Response
{
  "data": [
    {
      "id": "task_01",
      "title": "Design homepage",
      "status": "in_progress",
      "assignee": "user_03",
      "due_date": "2025-02-01"
    }
  ],
  "meta": { "total": 42, "page": 1 }
}

Rate Limits

API requests are limited to 1,000 requests/minute for Pro plans and 5,000 requests/minute for Enterprise plans.