API Reference

API Reference

The Workflows API is a RESTful API that uses JSON for request and response bodies.

Use the API reference when you are building an internal tool, connecting Loopfour to another system, or automating workflow lifecycle operations from code. The reference is organized by the resource you manage: workflows define the graph, runs capture execution, agents handle AI-assisted steps, connections represent authenticated integrations, webhooks receive provider events, and tables store structured operational data. Each endpoint page documents request fields, response shapes, and common error states so you can validate inputs before they reach production.

Most integrations should treat workflow IDs, run IDs, connection IDs, and table IDs as durable identifiers. Store them in your own system only when you need to reconcile Loopfour activity with external records such as invoices, customers, contracts, opportunities, or payment events. For finance workflows, also capture the run ID in downstream logs whenever possible. It gives operators a stable path back to execution details, step outputs, approval history, and failure diagnostics.

Base URL

https://api.justpaid.io/api/v1

Authentication

All requests require an API key in the x-api-key header:

curl -H "x-api-key: wfk_your_api_key" https://api.justpaid.io/api/v1/workflows

Endpoints

Response Format

All responses follow this format:

{
  "success": true,
  "data": { }
}

Error responses:

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid workflow configuration"
  }
}

HTTP Status Codes