Lead Score API
Retrieve the current score for a specific lead, including engagement and profile scores across all active rulesets.
GET /score/{leadID}
Get the current score for a lead.
Request
| Parameter | Type | Required | Description |
|---|---|---|---|
leadID | string | Yes | Lead identifier (path parameter) |
Response
200 OK
{
"lead_id": "ld_123",
"score": 75,
"ruleset_id": "ruleset-abc",
"engagement_scores": {
"ruleset-abc": 75,
"ruleset-xyz": 60
},
"profile_scores": {
"ruleset-fit": 45
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
lead_id | string | Lead identifier |
score | integer | Overall engagement score |
ruleset_id | string | Primary engagement ruleset |
engagement_scores | object | Map of ruleset ID to engagement score |
profile_scores | object | Map of ruleset ID to profile fit score |
Example
curl -X GET "https://api.leadvibe.com/score/ld_123" \
-H "Authorization: Bearer <token>"
Common Errors
| Status | Meaning | Solution |
|---|---|---|
| 401 | Unauthorized | Check authentication token |
| 404 | Not Found | Lead does not exist or not accessible |
Notes
- Scores are OU-scoped to the active Organizational Unit
- For real-time scores, use this endpoint; for historical trends, use Score History
- This endpoint can also be accessed as
GET /leads/{leadID}/score
Related Endpoints
- Score History - Historical score snapshots
- Score Explain - Understand score drivers
- Top Leads - Leads ranked by score