To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Lazily loaded, filterable list of Leads, used as a merge field value so templates and reports can list and filter a customer's or assignee's leads. An instance is created for a profile or organisation via leadsListForCustomer or leadsListForAssignedTo, and can then be narrowed with filterOnJourney, getActive, getCompleted or getCancelled, each of which returns a new LeadsList wrapping the same underlying query with an extra filter. The underlying leads are only fetched, up to 1000 at a time, the first time the list is read.
Extends: AbstractList
Properties
| Property | Returns | Description |
|---|---|---|
| active | LeadsList | This list narrowed to leads with an active status. |
| cancelled | LeadsList | This list narrowed to leads with a cancelled status. |
| completed | LeadsList | This list narrowed to leads with a completed status. |
| entity | BaseEntity | Customer entity, a profile or organisation, this list's leads belong to. Delegates up to the root of the filter chain, since only the base list carries the customer entity. |
| mostRecent | Lead | |
| oldest | Lead |
Methods
getEntity()
Returns: BaseEntity
Customer entity, a profile or organisation, this list's leads belong to. Delegates up to the root of the filter chain, since only the base list carries the customer entity.
filterOnJourney(String name)
Returns: LeadsList
Narrows this list to leads belonging to the named funnel journey.
| Parameter | Description |
|---|---|
name | the name of the funnel repository to filter by |
getActive()
Returns: LeadsList
This list narrowed to leads with an active status.
getCompleted()
Returns: LeadsList
This list narrowed to leads with a completed status.
getCancelled()
Returns: LeadsList
This list narrowed to leads with a cancelled status.
© 2025 Kademi Ltd