Skip to main content

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

ParameterTypeRequiredDescription
leadIDstringYesLead 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

FieldTypeDescription
idstringUnique alias identifier
kindstringAlias type: email, phone, cookie, external_id, social
valuestringThe alias value
created_attimestampWhen the alias was first seen

Example

curl -X GET "https://api.leadvibe.com/lead/ld_123/aliases" \
-H "Authorization: Bearer <token>"

Common Errors

StatusMeaningSolution
401UnauthorizedCheck authentication token
404Not FoundLead 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