Skip to main content
GET
/
campaigns-leads
/
{id}
Get a campaign lead
curl --request GET \
  --url https://api.dialnexa.com/v1/campaigns-leads/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "lead_abc123",
  "name": "Priya Sharma",
  "phone_number": "+919876543210",
  "campaign_id": "cmp_xyz789",
  "status": "completed",
  "notes": {
    "loan_amount": "250000",
    "product": "home_loan"
  },
  "call_log_id": "log_abc123",
  "created_at": "2024-03-01T10:00:00.000Z"
}
Returns the record for a single campaign lead: the contact phone_number, the metadata object that carries dynamic variables for the agent (such as customer_name or product), the lead’s current status in the campaign queue (pending, in_progress, completed, failed, removed), the timestamp it was enrolled, and, once a call has been placed, the call_log_id you can use to fetch the produced call log through Get Call Log.

​
When to use this

  • Per-lead troubleshooting: confirm the dynamic variables sent to the agent for a specific contact match what was expected.
  • Status polling: check whether a specific lead has been dialled yet without scanning the entire campaign.
  • CRM sync: pull the lead’s final status and call log reference to write back the outcome into the originating CRM.
For bulk reporting, use List Call Logs filtered by campaign_id instead.

​
Path parameters

ParameterDescription
idThe campaign-lead ID, for example cmp_5tw8vz2rnx1q. This is the ID returned when the lead was uploaded, it is distinct from the underlying call log ID.

​
Errors

  • 404 Not Found is returned when the lead does not exist or has been removed.
  • 403 Forbidden is returned when the API key cannot read campaign data on this workspace.

​
Request

curl "https://api.dialnexa.com/v1/campaigns-leads/cmp_5tw8vz2rnx1q" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

{
  "id": "lead_m4b7zx9nq2pw",
  "campaign_id": "cmp_5tw8vz2rnx1q",
  "phone_number": "+919876543210",
  "metadata": { "customer_name": "Priya Sharma", "product": "home_loan" },
  "status": "pending",
  "created_at": "2024-05-01T09:05:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Pass your API key as a Bearer token in the Authorization header.

Path Parameters

​
id
string
required

Response

Success.

​
id
string
Example:

"lead_abc123"

​
name
string
Example:

"Priya Sharma"

​
phone_number
string
Example:

"+919876543210"

​
campaign_id
string
Example:

"cmp_xyz789"

​
status
string
Example:

"completed"

​
notes
object
Example:
{
  "loan_amount": "250000",
  "product": "home_loan"
}
​
call_log_id
string | null
Example:

"log_abc123"

​
created_at
string<date-time>
Example:

"2024-03-01T10:00:00.000Z"