API Reference

Read your flows and tasks programmatically with the Booflow REST API.

1. Get an API key

API keys are created from your workspace. Go to Settings → API Keys and click Create key. Only workspace Owners and Admins can manage keys.

The key is shown once — copy it immediately and store it somewhere safe (a password manager or your server's environment variables). Booflow only stores a hash, so a lost key can't be recovered — you'd revoke it and create a new one.

2. Authenticate

Pass the key as a Bearer token in the Authorization header. All requests must be made over HTTPS. Keys look like bflow_sk_….

Authorization: Bearer bflow_sk_xxxxxxxxxxxxxxxxxxxxxxxx

https://booflow.com

GET /api/v1/flows

Lists flows in your workspace. Optional query params: ?status=ACTIVE, ?limit=50 (max 200).

curl https://booflow.com/api/v1/flows?status=ACTIVE \
  -H "Authorization: Bearer bflow_sk_xxxxxxxxxxxx"

# Response
{
  "data": [
    {
      "id": "cmp4n4ala001u...",
      "name": "Client Onboarding",
      "description": "New client kickoff",
      "status": "ACTIVE",
      "taskCount": 4,
      "dueDate": "2026-06-01T00:00:00.000Z",
      "completedAt": null,
      "createdAt": "2026-05-10T18:22:01.000Z",
      "updatedAt": "2026-05-14T11:03:44.000Z"
    }
  ],
  "count": 1
}

GET /api/v1/tasks

Lists tasks across your flows. Optional query params: ?flowId=<id>, ?status=READY, ?limit=50.

curl "https://booflow.com/api/v1/tasks?flowId=cmp4n4ala001u" \
  -H "Authorization: Bearer bflow_sk_xxxxxxxxxxxx"

# Response
{
  "data": [
    {
      "id": "cmp4task01...",
      "flowId": "cmp4n4ala001u...",
      "flowName": "Client Onboarding",
      "name": "Setup Meeting with client",
      "status": "COMPLETED",
      "type": "MEETING",
      "priority": "MEDIUM",
      "required": true,
      "dueDate": "2026-05-15T00:00:00.000Z",
      "approvalStatus": "APPROVED",
      "createdAt": "2026-05-10T18:22:01.000Z"
    }
  ],
  "count": 1
}

4. Errors

Errors return a JSON body with an error field and an appropriate HTTP status.

401  Missing/invalid/expired API key
{ "error": "Invalid or revoked API key" }

429  Rate limited — slow down
500  Something went wrong on our side

Write endpoints (create flows, update tasks, invite participants) are coming. Need one sooner? Let us know.