Skip to main content

Get Lead

GET /leads/{id}

Retrieve a single lead by ID with all fields including metadata, campaign, active workflow run, and current status.

Path Parameters

ParameterTypeRequiredDescription
idstring (uuid)YesLead ID

Example

curl https://api.getnexor.ai/api/public/leads/123e4567-e89b-12d3-a456-426614174000 \
-H "X-API-Key: nxr_live_your_api_key"

Responses

200 — Lead retrieved successfully

{
"id": "123e4567-e89b-12d3-a456-426614174000",
"first_name": "Carlos",
"last_name": "Lopez",
"email": "carlos@example.com",
"phone": "+56912345678",
"source": "api",
"company": "Acme Corp",
"title": null,
"metadata": {
"edad": 35,
"estado_lead": "calificado",
"broker_asociado": "Juan Perez"
},
"campaign": { "id": "uuid", "name": "Q1 Campaign" },
"activeWorkflowRun": {
"id": "uuid",
"workflow_id": "uuid",
"is_active": true,
"run_status": "running"
},
"workflow": {
"id": "uuid",
"name": "Sales Pipeline",
"goal_type": "appointment"
},
"currentStatus": {
"id": "uuid",
"key": "contacted",
"label": "Contacted",
"color": "#3b82f6",
"category": "active"
},
"assigned_user": {
"id": "uuid",
"name": "Ana",
"email": "ana@co.com",
"avatar_url": null
},
"created_at": "2026-02-10T12:00:00Z"
}

Response Fields

FieldTypeDescription
idstring (uuid)Unique lead identifier
first_namestringLead's first name
last_namestring | nullLead's last name
emailstring | nullLead's email address
phonestring | nullLead's phone number
sourcestringLead source (e.g., "api")
companystring | nullLead's company name
titlestring | nullLead's job title
metadataobjectArbitrary key-value data stored on the lead
campaignobject | nullCampaign the lead is tagged with (id, name)
activeWorkflowRunobject | nullThe lead's currently active workflow run
workflowobject | nullThe workflow associated with the active run
currentStatusobject | nullCurrent workflow status (key, label, color, category)
assigned_userobject | nullAssigned user (only for appointment goal type workflows)
created_atstring (date-time)When the lead was created

401 — Authentication error

See Authentication.

404 — Lead not found

{
"error": "Lead not found"
}

500 — Internal server error