Lead Aliases API
Retrieve the identifiers (aliases) associated with a lead. Aliases include email addresses, phone numbers, cookies, external IDs, and social handles that map to the same lead.
GET /lead/{leadID}/aliases
List all aliases for a specific lead.
Request
| Parameter | Type | Required | Description |
|---|---|---|---|
leadID | string | Yes | Lead identifier (path parameter) |
Response
200 OK
{
"aliases": [
{
"id": "alias-123",
"kind": "email",
"value": "alex@example.com",
"created_at": "2025-01-01T08:00:00Z"
},
{
"id": "alias-456",
"kind": "phone",
"value": "+1-555-0100",
"created_at": "2025-01-05T14:00:00Z"
},
{
"id": "alias-789",
"kind": "cookie",
"value": "c_abc123def456",
"created_at": "2025-01-10T09:00:00Z"
}
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
id | string | Unique alias identifier |
kind | string | Alias type: email, phone, cookie, external_id, social |
value | string | The alias value |
created_at | timestamp | When the alias was first seen |
Example
curl -X GET "https://api.leadvibe.com/lead/ld_123/aliases" \
-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
- Aliases are how LeadVibe identifies and deduplicates leads across events
- New aliases are added automatically when events are ingested with different identifiers that resolve to the same lead
- Aliases can also be added during lead import via alias mappings
Related Endpoints
- Lead Detail - View lead details
- Lead Import - Import leads with alias mappings
- Event Ingestion - Ingest events that create aliases