Leads
One lead
GET /v1/leads/{lead_id}
- Scope
leads:read- Tier
- Tier 1
- Data
- Personal data
- Idempotency
- Idempotency-Key: not used
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
lead_id | path | string (LeadId) | yes | |
X-Correlation-ID | header | string | no | Your own trace value, logged with the request. Metadata only, never identity. (min length 1; max length 128) |
Response
200: The lead. ETag can be sent back as If-Match when updating it.
| Header | Meaning |
|---|---|
X-Request-ID | The DialerBee request id. Quote it to support. Every response carries X-Request-ID: req_<ULID>, or edge_<32 hex> when the edge answered before the request reached the API. |
Cache-Control | Always no-store. |
ETag | The resource version. Send it back as If-Match. |
Examples
Request example
curl
curl -sS -X GET \
"https://app.dialerbee.com/api/v1/leads/lead_0f8fad5b-d9cb-469f-a165-70867728950e" \
-H "Authorization: Bearer $DIALERBEE_API_KEY"
Python (SDK)
from dialerbee import DialerBee
db = DialerBee() # reads DIALERBEE_API_KEY from the environment
result = db.leads.get("lead_0f8fad5b-d9cb-469f-a165-70867728950e")
Response example
200
{
"id": "lead_0f8fad5b-d9cb-469f-a165-70867728950e",
"campaign_id": "cmp_0f8fad5b-d9cb-469f-a165-70867728950e",
"external_id": "CRM-1001",
"phone": "+12125550101",
"full_name": "Ann Lee",
"email": "[email protected]",
"status": "contacted",
"attempts": 1,
"custom_fields": {
"tier": "gold"
},
"last_attempt_at": "2026-09-29T11:58:00Z",
"next_attempt_at": "2026-09-30T10:00:00Z",
"disposition_code": "interested",
"hangup_cause": "NORMAL_CLEARING",
"created_at": "2026-09-29T09:15:00Z",
"updated_at": "2026-09-29T09:20:00Z"
}
Error examples
403 insufficient_scope
{
"type": "https://docs.dialerbee.com/errors/insufficient-scope",
"title": "Not permitted",
"status": 403,
"detail": "The API client does not hold the scope this operation requires.",
"instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
"code": "insufficient_scope",
"request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}
401 invalid_api_key
{
"type": "https://docs.dialerbee.com/errors/invalid-api-key",
"title": "Invalid API key",
"status": 401,
"detail": "The Authorization header is missing, is not Bearer dbk_live_..., or the key is not recognised, has expired or was revoked (one answer for every key problem, so a key's state is never revealed).",
"instance": "urn:dialerbee:request:req_01K6BZ3M9X4T7Q2V8N5R6P1W0C",
"code": "invalid_api_key",
"request_id": "req_01K6BZ3M9X4T7Q2V8N5R6P1W0C"
}
Errors
| Status | Code | Title |
|---|---|---|
| 401 | invalid_api_key | Invalid API key |
| 403 | api_access_disabled | API access disabled |
| 403 | ip_not_allowed | IP address not allowed |
| 403 | insufficient_scope | Not permitted |
| 400 | credential_in_url | Credential in URL |
| 400, 422 | validation_failed | Invalid request |
| 404 | not_found | Not found |
| 429 | rate_limit_exceeded | Too many requests |
| 503 | temporarily_unavailable | Temporarily unavailable |
| 503 | upstream_unavailable | Temporarily unavailable |
| 502 | upstream_invalid_response | Upstream error |
| 500 | internal_error | Internal error |
Objects
Lead
| Field | Type | Required | Description |
|---|---|---|---|
id | string (LeadId) | yes | A lead (a contact of a campaign). lead_ + a lower-case UUID. |
campaign_id | string (CampaignId) or null | yes | |
external_id | string or null | yes | Your id for this lead, if this API client set one. |
phone | string | yes | |
full_name | string or null | yes | |
email | string or null | yes | |
status | string | yes | |
attempts | integer | yes | |
custom_fields | object or null | yes | |
last_attempt_at | string (date-time) or null | yes | |
next_attempt_at | string (date-time) or null | yes | |
disposition_code | string or null | yes | The agent's outcome of the last attempt, if any. |
hangup_cause | string or null | yes | The carrier's outcome of the last attempt, if any. |
created_at | string (date-time) | yes | |
updated_at | string (date-time) | yes |