Endpoints

Leads Endpoints

List workspace leads and update lead records

The leads tag provides endpoints for retrieval and updates.

List Workspace Leads

GET /v2/leads

Retrieves leads for the workspace with filters, sorting, and cursor pagination.

Query Parameters

NameTypeDescription
sort_bystringnewest_first, oldest_first, last_touch_first, last_touch_last, most_engaged_first, least_engaged_first
start_datestring (YYYY-MM-DD)Start date in UTC
end_datestring (YYYY-MM-DD)End date in UTC
daysintegerOverrides start_date/end_date with a rolling range
statusstringNEW, QUALIFIED, DISQUALIFIED
company_public_idstringCompany LinkedIn handle or numeric id
post_idstringFilter by originating post. Obtain post IDs from the Content team feed endpoint
email_enrichedbooleantrue = enriched emails only, false = non-enriched only, omit = all leads
cursorstringCursor token from previous response page
limitinteger (1–50)Max leads per page. Default 50

Tip

When both days and start_date are provided, days takes precedence.

Example Request

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

Response Shape

FieldTypeNotes
totalintegerTotal leads count
has_morebooleanWhether additional pages exist
cursorstring | nullCursor for next page
itemsarrayLead items for this page

Lead Item Fields

FieldTypeNotes
idstringLead identifier
first_namestring | null
last_namestring | null
headlinestring | nullLinkedIn headline
job_titlestring | null
usernamestring | nullLinkedIn username
linkedin_urlstring | null
contact_emailstring | nullEnriched email if available
phone_numberstring | null
enrichment_statusstring | nullEmail enrichment state
team_member_emailstring | nullTeam member who sourced the lead
sourcestring | nullHow the lead was captured
source_content_urlstring | nullURL of the originating post
statusstring | nullNEW, QUALIFIED, DISQUALIFIED
tagsstring[]Label list
engagement_events_countinteger | nullRaw event count
engagement_scoreinteger | nullComputed score (0–100)
is_icp_matchbooleanWhether lead matches ICP criteria
is_account_basedbooleanAccount-based flag
historyarrayShallow history records
picturestring | nullProfile picture URL
followers_countinteger | null
connections_countinteger | null
countrystring | null
created_atstring (datetime)Lead creation timestamp (UTC)
last_engagement_dtstring | nullMost recent engagement timestamp
companyobject | nullNested company details

Example Response

{
  "total": 1,
  "has_more": false,
  "cursor": null,
  "items": [
    {
      "id": "lead_abc123",
      "first_name": "Jane",
      "last_name": "Smith",
      "headline": "VP of Marketing at Acme Corp",
      "job_title": "VP of Marketing",
      "username": "jane-smith",
      "linkedin_url": "https://www.linkedin.com/in/jane-smith",
      "contact_email": "jane@acme.com",
      "phone_number": null,
      "enrichment_status": "ENRICHED",
      "team_member_email": "owner@example.com",
      "source": "POST",
      "source_content_url": "https://www.linkedin.com/feed/update/urn:li:activity:123456",
      "status": "NEW",
      "tags": ["enterprise", "fintech"],
      "engagement_events_count": 5,
      "engagement_score": 82,
      "is_icp_match": true,
      "is_account_based": false,
      "history": [],
      "picture": "https://my.teamfluence.app/placeholders/default-profile.png",
      "followers_count": 1200,
      "connections_count": 500,
      "country": "US",
      "feed_updated_at": "2026-08-01T09:15:00Z",
      "created_at": "2026-07-15T14:30:00Z",
      "last_engagement_dt": "2026-08-01T09:15:00Z",
      "company": {
        "name": "Acme Corp",
        "slug": "acme-corp",
        "website_url": "https://acme.com",
        "employees_num_min": 201,
        "employees_num_max": 500,
        "headquarters": "San Francisco, CA",
        "country": "US",
        "founded_year": 2012,
        "industries": ["Software Development"],
        "linkedin_url": "https://www.linkedin.com/company/acme-corp",
        "created_at": "2026-06-01T00:00:00Z"
      }
    }
  ]
}

Update Lead

PATCH /v2/leads/{lead_id}

Updates a lead's status, tags, note, CRM information, and ICP match state.

Path Parameter

NameTypeRequired
lead_idstringyes

Request Body Fields (LeadUpdatePayload)

FieldTypeNotes
statusstring | nullNEW, QUALIFIED, DISQUALIFIED
tagsstring[] | nullUpdates tag list
noteobject | nullNote payload
crm_idstring | nullExternal CRM identifier
crm_contact_urlstring | nullCRM contact URL
is_icp_matchboolean | nullICP match flag

Note Object

FieldTypeNotes
note_idstring | nullIf omitted or null, a new note is created
note_contentstringNote text

Example Request

curl -X PATCH "https://api.teamfluence.com/v2/leads/<lead_id>" \
  -H "Authorization: Bearer $TEAMFLUENCE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "DISQUALIFIED",
    "tags": ["not-a-fit"],
    "is_icp_match": false,
    "note": {
      "note_id": null,
      "note_content": "Outside target region"
    }
  }'

Responses

  • 200: update accepted
  • 422: validation error