Quick Start

This guide helps you call Teamfluence API in a few minutes.

Prerequisites

Before you begin, make sure you have:

A Teamfluence account
An API key generated in workspace settings
A terminal with curl installed

First API Call

Export your API key

Save your API key as an environment variable:

export TEAMFLUENCE_API_KEY="your_api_key"

Call the health endpoint

Verify connectivity and API availability:

curl -X GET "https://api.teamfluence.com/v2/health" \
  -H "Accept: application/json"

import requests

response = requests.get(
    "https://api.teamfluence.com/v2/health",
    headers={"Accept": "application/json"},
    timeout=30,
)

print(response.status_code)
print(response.text)

const response = await fetch("https://api.teamfluence.com/v2/health", {
  method: "GET",
  headers: {
    Accept: "application/json",
  },
});

console.log(response.status);
console.log(await response.text());

Call an authenticated endpoint

Fetch your workspace credits balance:

curl -X GET "https://api.teamfluence.com/v2/workspace/credits" \
  -H "Authorization: Bearer $TEAMFLUENCE_API_KEY" \
  -H "Accept: application/json"

import os
import requests

response = requests.get(
    "https://api.teamfluence.com/v2/workspace/credits",
    headers={
        "Authorization": f"Bearer {os.environ['TEAMFLUENCE_API_KEY']}",
        "Accept": "application/json",
    },
    timeout=30,
)

print(response.status_code)
print(response.json())

const response = await fetch("https://api.teamfluence.com/v2/workspace/credits", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.TEAMFLUENCE_API_KEY}`,
    Accept: "application/json",
  },
});

console.log(response.status);
console.log(await response.json());

List leads with filters

Query leads created in a recent period:

curl -G "https://api.teamfluence.com/v2/leads" \
  -H "Authorization: Bearer $TEAMFLUENCE_API_KEY" \
  --data-urlencode "days=30" \
  --data-urlencode "sort_by=newest_first"

import os
import requests

response = requests.get(
    "https://api.teamfluence.com/v2/leads",
    headers={"Authorization": f"Bearer {os.environ['TEAMFLUENCE_API_KEY']}"},
    params={
        "days": 30,
        "sort_by": "newest_first",
    },
    timeout=30,
)

print(response.status_code)
print(response.json())

const params = new URLSearchParams({
  days: "30",
  sort_by: "newest_first",
});

const response = await fetch(`https://api.teamfluence.com/v2/leads?${params.toString()}`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.TEAMFLUENCE_API_KEY}`,
    Accept: "application/json",
  },
});

console.log(response.status);
console.log(await response.json());

Update a Lead

curl -X PATCH "https://api.teamfluence.com/v2/leads/<lead_id>" \
  -H "Authorization: Bearer $TEAMFLUENCE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "QUALIFIED",
    "tags": ["priority", "demo-requested"],
    "crm_id": "crm-12345",
    "crm_contact_url": "https://crm.example.com/contacts/12345",
    "is_icp_match": true,
    "note": {
      "note_id": null,
      "note_content": "Reached out and booked a call."
    }
  }'

import os
import requests

lead_id = "lead_123"
payload = {
    "status": "QUALIFIED",
    "tags": ["priority", "demo-requested"],
    "crm_id": "crm-12345",
    "crm_contact_url": "https://crm.example.com/contacts/12345",
    "is_icp_match": True,
    "note": {
        "note_id": None,
        "note_content": "Reached out and booked a call.",
    },
}

response = requests.patch(
    f"https://api.teamfluence.com/v2/leads/{lead_id}",
    headers={
        "Authorization": f"Bearer {os.environ['TEAMFLUENCE_API_KEY']}",
        "Content-Type": "application/json",
    },
    json=payload,
    timeout=30,
)

print(response.status_code)
print(response.text)

const leadId = "lead_123";

const response = await fetch(`https://api.teamfluence.com/v2/leads/${leadId}`, {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.TEAMFLUENCE_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    status: "QUALIFIED",
    tags: ["priority", "demo-requested"],
    crm_id: "crm-12345",
    crm_contact_url: "https://crm.example.com/contacts/12345",
    is_icp_match: true,
    note: {
      note_id: null,
      note_content: "Reached out and booked a call.",
    },
  }),
});

console.log(response.status);
console.log(await response.text());

Common Headers

Accept: application/json
Authorization: Bearer <your_api_key>
Content-Type: application/json

Info

All endpoint paths are prefixed with /v2 and served from https://api.teamfluence.com.