API Reference Overview

The FlowStack REST API lets you programmatically manage automations, trigger flows, retrieve run history, and interact with all platform features.

Base URL

https://app.onflowstack.com/api/v1

Authentication

All API requests require authentication via Bearer token in the Authorization header:

curl -X GET https://app.onflowstack.com/api/v1/flows \
  -H "Authorization: Bearer YOUR_API_KEY"

See Authentication for details on generating API keys.

Request Format

• Content-Type: application/json for all request bodies
• Method: GET for reads, POST for creates/updates, DELETE for removals
• Pagination: List endpoints support cursor and limit query parameters

Response Format

All responses return JSON with a consistent structure:

Success (single resource):

{
  "id": "flow_abc123",
  "name": "My Automation",
  "status": "ACTIVE",
  "created": "2026-04-21T10:30:00Z",
  "updated": "2026-04-21T10:30:00Z"
}

Success (list):

{
  "data": [
    { "id": "flow_abc123", "name": "My Automation" },
    { "id": "flow_def456", "name": "Daily Report" }
  ],
  "cursor": "eyJpZCI6ImZsb3dfZGVmNDU2In0=",
  "hasMore": true
}

Error:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The 'name' field is required",
    "statusCode": 400
  }
}

Available Endpoints

Resource	Endpoints
Flows	List, create, update, delete, enable, disable
Flow Runs	List, get, trigger manual run
Connections	List, create, delete
Pieces	List available pieces and their actions/triggers
Webhooks	Get webhook URLs, test webhooks

Rate Limits

See Rate Limits for current limits by plan.

SDKs

• JavaScript/TypeScript SDK — @flowstack/sdk (npm)
• Embedding SDK — @flowstack/embed-sdk for white-label integrations

See Embedding SDK for the embed SDK documentation.