Quickstart

Get started with the AdaptEngine API

Authentication

All API requests require a bearer token in the Authorization header:

curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://api.adaptengine.com/api/v1/leads

Response Format

All responses use a consistent envelope:

Success

{
  "ok": true,
  "data": { ... }
}

Common Operations

List Leads

Fetch leads with optional filtering and pagination:

curl -X GET "https://api.adaptengine.com/api/v1/leads?pageSize=20" \
  -H "Authorization: Bearer YOUR_TOKEN"

Query Parameters:

Parameter	Type	Description
filter	object	Filter criteria (JSON encoded)
include	string[]	Related data to include
fields	string[]	Specific fields to return
cursor	string	Pagination cursor
pageSize	number	Results per page (default: 20)

Get Lead Detail

Fetch a single lead with all details:

curl -X GET "https://api.adaptengine.com/api/v1/leads/{leadId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Update Pipeline Stage

Move a lead through your pipeline:

curl -X POST "https://api.adaptengine.com/api/v1/leads/{leadId}/pipeline" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "stage": "qualified",
    "notes": "Initial qualification complete"
  }'

Trigger Augmentation

Start AI enrichment for a lead:

curl -X POST "https://api.adaptengine.com/api/v1/leads/{leadId}/augmentation" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "steps": ["signals", "scoring", "gonogo"]
  }'

Next Steps

Leads

Learn about lead data structure and views

Pipeline

Understand pipeline stages and transitions

Augmentation

Explore AI-powered enrichment

API Reference

Full endpoint documentation