API Reference

Flintt Public API

Manage companies, prospects, signals, and runs programmatically. Authenticate with API keys, subscribe to webhook events.

⚠

The Flintt API is in beta. Endpoints may change before general availability.

Base URL

https://api.flintt.co

Version

v1

Format

JSON

Auth

X-API-Key

Authentication

Two methods depending on the endpoint:

X-API-KeyRecommended

Pass your API key in the X-API-Key header for all /v1/ endpoints.

X-API-Key: flt_ab12ef34cd56...

Authorization: BearerManagement only

JWT token for management endpoints: /api/api-key, /api/outbound-webhooks.

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

API Key

GET

https://api.flintt.co/api/api-key

Get API Key

Returns your API key metadata. If no key exists yet, one is automatically generated and the raw key is returned once - save it immediately.

AuthAuthorization: Bearer required

Response Fields

idstring

UUID of the key.

key_prefixstring

First 12 characters for identification.

raw_keystring?

Full key - only present on first creation. Store it immediately.

last_used_atstring | null

ISO 8601 timestamp of last use.

created_atstring

ISO 8601 creation timestamp.

POST

https://api.flintt.co/api/api-key/regenerate

Regenerate API Key

Revoke the current key and generate a new one. The new raw key is returned once - update your integrations before regenerating.

AuthAuthorization: Bearer required

Response Fields

idstring

UUID of the new key.

raw_keystring

New full API key - shown once only.

key_prefixstring

First 12 characters for identification.

created_atstring

ISO 8601 creation timestamp.

Webhooks

GET

https://api.flintt.co/api/outbound-webhooks

List Webhook Endpoints

List all configured outbound webhook endpoints. Auth tokens are never included in responses.

AuthAuthorization: Bearer required

Response Fields

idstring

UUID of the webhook endpoint.

namestring

Human-readable label.

endpoint_urlstring

Destination URL for event delivery.

event_typesstring[]

Subscribed event types.

activeboolean

Whether delivery is active.

created_atstring

ISO 8601 creation timestamp.

POST

https://api.flintt.co/api/outbound-webhooks

Create Webhook Endpoint

Register a new outbound webhook. Flintt will send a POST request with an Authorization: Bearer <token> header. The token is returned once - add it as a Header Auth credential in n8n or similar tools.

AuthAuthorization: Bearer required

Request Body

namestringreq

Human-readable label (e.g. "n8n workflow").

endpoint_urlstringreq

HTTPS URL to deliver events to.

event_typesstring[]req

Event types to subscribe to. Valid: "signal.run.completed", "signal.run.result", "company.created", "prospect.created".

activeboolean

Whether delivery is active. Defaults to true.

Response Fields

auth_tokenstring

Bearer token Flintt sends in the Authorization header - shown once. Use it to verify incoming requests.

PATCH

https://api.flintt.co/api/outbound-webhooks/{webhook_id}

Update Webhook Endpoint

Update the name, URL, subscribed events, or enabled status.

AuthAuthorization: Bearer required

Path Parameters

webhook_idstringreq

UUID of the webhook to update.

Request Body

namestring

New label.

endpoint_urlstring

New destination URL.

event_typesstring[]

New event type subscriptions.

activeboolean

Enable or disable delivery.

DELETE

https://api.flintt.co/api/outbound-webhooks/{webhook_id}

Delete Webhook Endpoint

Permanently delete a webhook endpoint.

AuthAuthorization: Bearer required

Path Parameters

webhook_idstringreq

UUID of the webhook to delete.

Companies

GET

https://api.flintt.co/v1/companies

List Companies

Returns all companies in your workspace.

AuthX-API-Key required

Response Fields

idstring

UUID of the company.

namestring

Company name.

domainstring | null

Primary website domain.

created_atstring

ISO 8601 creation timestamp.

POST

https://api.flintt.co/v1/companies

Create Company

Add a new company to your workspace.

AuthX-API-Key required

Request Body

namestringreq

Company name.

domainstring

Primary website domain (e.g. acme.com).

linkedin_urlstring

LinkedIn company page URL.

Prospects

GET

https://api.flintt.co/v1/prospects

List Prospects

Returns all prospects in your workspace.

AuthX-API-Key required

Response Fields

idstring

UUID of the prospect.

namestring

Full name.

emailstring | null

Email address.

company_idstring | null

Associated company UUID.

created_atstring

ISO 8601 creation timestamp.

POST

https://api.flintt.co/v1/prospects

Create Prospect

Add a new prospect to your workspace.

AuthX-API-Key required

Request Body

namestringreq

Full name.

emailstring

Work email address.

titlestring

Job title.

linkedin_urlstring

LinkedIn profile URL.

company_idstring

UUID of the associated company.

Signals

GET

https://api.flintt.co/v1/signals

List Signals

Returns all signals configured in your workspace.

AuthX-API-Key required

Response Fields

idstring

UUID of the signal.

namestring

Display name.

statusstring

"active", "paused", or "draft".

schedulestring | null

Cron expression for automated runs.

created_atstring

ISO 8601 creation timestamp.

POST

https://api.flintt.co/v1/signals

Create Signal

Create a new signal monitoring job.

AuthX-API-Key required

Request Body

namestringreq

Display name.

descriptionstring

What this signal monitors.

schedulestring

Cron expression (e.g. 0 8 * * 1-5).

GET

https://api.flintt.co/v1/signals/{signal_id}

Get Signal

Retrieve a single signal by ID.

AuthX-API-Key required

Path Parameters

signal_idstringreq

UUID of the signal.

PATCH

https://api.flintt.co/v1/signals/{signal_id}

Update Signal

Update a signal's name, description, status, or schedule.

AuthX-API-Key required

Path Parameters

signal_idstringreq

UUID of the signal to update.

Request Body

namestring

New display name.

statusstring

"active" or "paused".

schedulestring | null

New cron expression, or null to disable.

DELETE

https://api.flintt.co/v1/signals/{signal_id}

Delete Signal

Permanently delete a signal and all its associated runs.

AuthX-API-Key required

Path Parameters

signal_idstringreq

UUID of the signal to delete.

Runs

GET

https://api.flintt.co/v1/runs

List Runs

Returns all signal runs, newest first.

AuthX-API-Key required

Query Parameters

signal_idstring

Filter runs for a specific signal UUID.

limitinteger

Max results. Defaults to 50.

offsetinteger

Pagination offset. Defaults to 0.

Response Fields

idstring

UUID of the run.

signal_idstring

UUID of the parent signal.

statusstring

"pending", "running", "completed", or "failed".

results_countinteger

Number of results found.

completed_atstring | null

ISO 8601 completion timestamp.

GET

https://api.flintt.co/v1/runs/{run_id}

Get Run

Retrieve a single run and its results.

AuthX-API-Key required

Path Parameters

run_idstringreq

UUID of the run.

MCP

Beta

The Flintt MCP server exposes the v1 API as Model Context Protocol tools. Connect Claude.ai, Claude Desktop, or any MCP-compatible client and let it query your CRM and signals directly.

Claude.aiRecommended

1. Settings → Connectors → Add custom connector
2. Paste your server URL — include ?api_key= for auth:

https://api.flintt.co/mcp?api_key=flt_your_api_key

Claude Desktop

Add to claude_desktop_config.json and restart:

JSON

{
  "mcpServers": {
    "flintt": {
      "type": "sse",
      "url": "https://api.flintt.co/mcp",
      "headers": { "X-API-Key": "flt_your_api_key" }
    }
  }
}

Available tools

list_companieskey

List CRM companies, with optional name filter.

create_companykey

Add a company to the CRM.

list_prospectskey

List pipeline deals, filterable by stage.

create_prospectkey

Add a prospect to the pipeline.

list_signalskey

List all signals/triggers.

get_signalkey

Get details for a specific signal.

create_signalkey

Create a new signal.

update_signalkey

Update an existing signal.

delete_signalkey

Delete a signal.

list_docspublic

Index of available documentation files.

get_docpublic

Read a doc file by slug (signals-architecture, sql-structure, mcp-setup…).

key — requires X-API-Key or ?api_key=. public — no auth needed.