Lead Histories

Lead histories track all status changes for leads over time.

List Lead Histories

GET/lead-histories Bearer Token — view leads

Retrieve a paginated list of lead status change history.

Parameter	Type	Required	Description
per_page	number	No	Results per page

Response

Success (200):

{
  "data": [
    {
      "lead_reference": "LED-00001",
      "old_status": "new",
      "new_status": "confirmed",
      "changed_by": "Agent Name",
      "changed_at": "2025-01-16T09:00:00Z"
    },
    {
      "lead_reference": "LED-00002",
      "old_status": "new",
      "new_status": "no_reply",
      "changed_by": "Agent Name",
      "changed_at": "2025-01-16T09:30:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 1200,
      "pages": 24
    }
  }
}

Show Lead History

GET/lead-histories/{id}/show Bearer Token — view leads

Retrieve a single lead history entry by ID.

Response

Success (200):

{
  "data": {
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "lead_reference": "LED-00001",
    "old_status": "new",
    "new_status": "confirmed",
    "changed_by": "Agent Name",
    "changed_at": "2025-01-16T09:00:00Z"
  },
  "meta": {}
}

Not found (404):

{
  "error": {
    "code": "HTTP_ERROR",
    "message": "Resource not found."
  }
}