Skip to main content
GET
/
api
/
lead-management
/
{id}
Get a lead management configuration by id
curl --request GET \
  --url https://your-instance.example.com/api/lead-management/{id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "_id": "665f1a0c0e0a4b001a2c9f40",
    "configurationName": "Facebook Lead Ad Funnel",
    "source": "Facebook Lead Ad",
    "initialStage": "New Lead",
    "status": "active"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

Configuration returned

​
success
boolean
required
​
data
object
required
Example:
{
  "_id": "665f1a0c0e0a4b001a2c9f40",
  "organizationId": "64ee9a8b1e7f2a0011223344",
  "userId": "64ee9a8b1e7f2a0011223399",
  "configurationName": "Facebook Lead Ad Funnel",
  "name": "FB Lead Ad",
  "description": "Routes Facebook Lead Ad submissions through the warm-up sequence.",
  "source": "Facebook Lead Ad",
  "inboundEmail": "leads+fb@inbound.example.com",
  "initialStage": "New Lead",
  "defaultProcess": "64eea1110000000000000001",
  "isAutopilot": true,
  "allowRecontact": false,
  "starterMessage": "Hi {{firstName}}, thanks for your interest!",
  "costPerLead": 12.5,
  "status": "active",
  "pipelineId": "64eea1110000000000000010",
  "pipelineStage": "New Lead",
  "createApplication": false,
  "forwardToOutreach": true,
  "useWorkflowOnly": false,
  "createdAt": "2026-05-01T09:00:00.000Z",
  "updatedAt": "2026-05-10T15:23:00.000Z"
}