Guides
Start typing to search…
  1. Getting Started

Getting Started

Welcome to the FlowMind API! This guide will help you get up and running quickly.

What is FlowMind?

FlowMind is a productivity platform that helps you achieve your goals through structured task management, personal CRM, and note-taking. The API gives you programmatic access to all your data, enabling powerful integrations and automations.

Quick Start

1. Get Your API Key

First, you'll need an API key to authenticate your requests:

  1. Log in to your FlowMind account at flowmind.life
  2. Navigate to Settings → API Keys
  3. Click Generate New API Key
  4. Copy and securely store your key (it won't be shown again)

2. Make Your First Request

Test your API key by fetching your goals:

curl -X GET "https://flowmind.life/api/v1/goals" \
  -H "Authorization: Bearer YOUR_API_KEY"

You should receive a JSON response with your goals:

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "title": "Learn a new language",
      "status": "active",
      "category": "learning",
      "progress": 25
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 1,
      "hasMore": false
    }
  }
}

A goal is a larger outcome you want to achieve over time. It is similar to a project, and it is made up of many tasks and sub-tasks.

For example, a goal could be “Lose 30 pounds,” and it may include tasks such as:

  1. Eat healthy (Task 1)
  2. Daily exercise (Task 2)
    1. Running for 30 minutes in the morning (Sub-task 1)
    2. Swimming for 30 minutes in the afternoon (Sub-task 2)
  3. Sleep monitoring (Task 3)

Each task and sub-task helps move you closer to the goal by breaking a long-term objective into clear, manageable actions.


3. Create Your First Task

Create a task linked to a goal:

curl -X POST "https://flowmind.life/api/v1/tasks" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Today\'s first task",
    "priority": "high",
    "due_date": "2024-12-20",
    "goal_id": "550e8400-e29b-41d4-a716-446655440000"
  }'

You can see it right away on the website!


Core Concepts

Goals

Long-term objectives organized by life areas (business, career, health, personal, learning, financial). Track progress from 0-100%.

Tasks

Actionable items with priorities, due dates, and energy levels. Link tasks to goals and break them down into subtasks.

Notes

Store thoughts, meeting notes, and ideas. Link notes to tasks for context. Use protection for sensitive content.

People

Your personal CRM. Store contacts with relationship details, personality insights, and interaction history.

Tags

Organize your contacts with custom tags for easy filtering and grouping.

Base URL

All API requests should be made to:

https://flowmind.life/api/v1

Response Format

All responses are JSON. Successful responses include a data field. List endpoints also include meta with pagination info.

Next Steps

Updated about 2 hours ago