Skip to main content

Events for a Lead API

Retrieve all engagement events for a specific lead, ordered by most recent first.

GET /events/{leadID}

List events for a specific lead.

Request

ParameterTypeRequiredDescription
leadIDstringYesLead identifier (path parameter)
pageintegerNoPage number (default: 1)
limitintegerNoResults per page (default: 25, max: 100)
event_typestringNoFilter by event type

Response

200 OK

{
"events": [
{
"id": "evt-123",
"lead_id": "ld_456",
"event_type": "page_view",
"metadata": {
"path": "/pricing",
"referrer": "https://google.com"
},
"created_at": "2025-01-15T10:30:00Z"
}
],
"total": 42,
"page": 1,
"limit": 25
}

Example

curl -X GET "https://api.leadvibe.com/events/ld_456?page=1&limit=25" \
-H "Authorization: Bearer <token>"

Common Errors

StatusMeaningSolution
401UnauthorizedCheck authentication token
404Not FoundLead does not exist or not accessible

Notes

  • Events are returned in reverse chronological order (most recent first)
  • Results are OU-scoped to the active Organizational Unit