Capturia / docs
FR

API v1 · Public

Quick start

Capture your first leads via the Capturia API in 5 minutes. No support contact needed.

  1. 1Create an API key

    In the Capturia dashboard, go to Admin → Account → API keys. Click Create a key, give it a name (e.g. Webflow Funnel), choose the Lead capture preset, and accept the CASL/Law 25 terms. The key is shown only once — copy it now.

  2. 2Verify the key works

    First, test with GET /v1/me which returns key info without modifying anything. If you get 200 OK, your key is valid.

    curl -X GET 'https://app.capturia.io/api/v1/me' \
  -H 'Authorization: Bearer cap_live_<your-key>' \
  -H 'Content-Type: application/json'

  3. 3Capture your first lead

    The lead must have given explicit SMS consent (CASL/Law 25). Capturia keeps a timestamped record of that attestation.

    phone — Accepted formats: E.164 (+15145551234), 10-digit NANP (5145551234), 11-digit NANP (15145551234), or formatted variants ((514) 555-1234, 514-555-1234). 10-digit numbers are automatically prefixed with +1.

    sms_consent — Accepts true (boolean) or the strings "true", "yes", "oui", "vrai", "1", "on", "checked" (case-insensitive). Useful for form-builders (Zapier, Make, HubSpot) that stringify booleans.

    curl -X POST 'https://app.capturia.io/api/v1/leads/capture' \
  -H 'Authorization: Bearer cap_live_<your-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "phone": "+15145551234",
  "first_name": "Marie",
  "last_name": "Tremblay",
  "sms_consent": true,
  "source_label": "webflow_form"
}'

  4. 4Verify it arrives in My Prospects

    The lead appears immediately in My Prospects in the dashboard. If configured, the SMS pre-suasion AI agent fires the first message within 30 seconds.

  5. 5Go further

    See Authentication for scopes and presets, Conventions for idempotency, pagination and errors, or API reference for all 29 endpoints.

MCP connector

Connect Capturia to your AI assistant

Capturia exposes an MCP server (Model Context Protocol), the standard that plugs AI assistants like Claude and ChatGPT into your software. Once connected, you ask — by text or by voice from your phone: "How many appointments do I have today?", "Find the contact Jean Bouchard", "What's the state of my pipeline?" — and your assistant answers with your real Capturia data, after asking your permission to use each tool.

What your assistant can look up

  • Your today's appointments, in chronological order.

  • Your recent leads, newest first.

  • Your pipeline summary: each stage with its deal count and value.

  • Contact search by name, email or company — "Jean Bouchard" matches first + last name, in any order.

  • Your conversations with your AI agents — summaries only, never message bodies.

  • Your API key usage: permissions, hourly limit, call volume.

With a Read only key, your assistant looks things up without being able to modify anything. With a Read + write key, it can also act — one record at a time: create a contact, book a meeting, add or remove a tag, move a contact in the pipeline, prepare an SMS or email draft. With a Full integration key, it can also prepare an SMS re-engagement campaign — but never send it on its own: it shows you the real audience (after consent), the credit cost and message samples, and nothing goes out without your explicit confirmation (single-use token, expires in 10 minutes). Sending always stays a human move.

Two ways to connect

OAuth — with your Capturia account

Add a custom connector in your assistant with the server URL — that's it: a Capturia window opens, you sign in with your usual account and authorize access. No key to copy. The granted access is equivalent to the Read only preset.

API key — for scripted integrations

Create a key with the Read only preset (lookups) or Read + write (actions) in Admin → Account → API keys, then give it to the connector in the Authorization header. The key can be revoked at any time — the assistant loses access immediately.

# MCP server URL
https://app.capturia.io/api/mcp

# API-key mode only — authorization header
Authorization: Bearer cap_your_key

Scopes and presets are detailed in Authentication.

Stuck?

The error catalog lists every code with an action hint. If you're truly blocked, contact support.