DocumentationAPI ReferenceAPI Overview
API Reference

API Overview

Introduction to the Castor Flow REST API.


The Castor Flow API is a REST API that gives you programmatic access to your leads, pipeline data, and CRM functionality.

Base URL

https://api.castorflow.com/v1

Authentication

All requests require an API key passed in the Authorization header. See the Authentication guide for how to generate a key.

Response format

All responses are JSON. Successful responses return HTTP 200 with a data object. Errors return an appropriate HTTP status code with an error message.

// Success
{ "data": { ... } }

// Error
{ "error": "Business not found", "code": "NOT_FOUND" }

Available resources

  • /businesses — your saved leads
  • /interactions — contact history entries
  • /pipeline — stage configuration