API Documentation

Integrate Caqophony products into your applications using our REST API.

Quick Start

  1. 1
    Create an API key in the API Keys section.
  2. 2
    Add the API key to your requests using the x-api-key header.
  3. 3
    Make requests to the Flowrunner API endpoints.

Example Request

curl -X GET \
  https://flowrunner.caqophony.com/api/bd/companies \
  -H "x-api-key: frun_your_api_key_here" \
  -H "Content-Type: application/json"

Response:

{
  "companies": [
    {
      "id": "comp_abc123",
      "name": "Acme Corp",
      "domain": "acme.com",
      "status": "prospect",
      "industry": "Technology"
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

Available Endpoints

GET/api/bd/companies

List all companies in your pipeline

Product: FlowrunnerAuth: API Key
GET/api/bd/prospects

List all prospects (contacts)

Product: FlowrunnerAuth: API Key
POST/api/api-keys/create

Create a new API key

Product: SwarmAuth: Session
POST/api/api-keys/revoke

Revoke an existing API key

Product: SwarmAuth: Session

OpenAPI Specification

Download the full OpenAPI 3.0 specification for use with tools like Postman, Insomnia, or code generators.

View OpenAPI Spec

Rate Limits

PlanRequests/Minute
Starter100
Pro500
Enterprise2,000

Resources

Manage API Keys

Create and revoke API keys

Token Pool

Monitor API usage

Help Center

API usage guides