Skip to main content

List leads

GET 
/partner/lead

Returns a paginated, summarised list of your leads — eleven fields per row, newest first. This is the grid view: besides what identifies the row, it carries the pre-approval's validity (vigenteHasta) and the lead's declared salaries (sueldoBruto, sueldoLiquido), and no contact data. For contact details use Get lead details, and for the evaluation itself use Get an evaluation by lead id.

To fetch the rows for specific people instead of paging through all of them, use List leads by RUT — same rows, same scope.

Requires the evaluation module.

What the list includes​

  • Archived leads are included. estado reflects the situation, so your grid reconciles against your own CRM.
  • Leads with any BNPL pre-approval are excluded, expired or not, matching the scope of the other endpoints in this group.
  • Leads with no pre-approval at all are included, with resultado and idPreAprobacion set to null.
  • resultado is the outcome of the most recent mortgage pre-approval, or null when the lead has none.

resultado and idPreAprobacion here are orientative​

This list resolves the most recent mortgage pre-approval without discarding expired or complementary ones. The evaluation reads discard both. For most leads the two agree, but they can disagree for the same lead:

Newest mortgage pre-approvalThis listEvaluation read
valid, not complementaryreturns itreturns the same one
valid, complementaryreturns itthe newest valid non-complementary one, or idPreAprobacion: null
expiredreturns itidPreAprobacion: null, or 404 when none of the lead's pre-approvals is still valid

So a row here can show an idPreAprobacion that the evaluation read will not confirm. Treat this list as the grid view and the evaluation read as the authoritative answer for a single lead.

Pagination is forgiving​

page is zero-based. A pageSize above the ceiling is clamped to the ceiling rather than rejected, and an out-of-range or non-numeric page or pageSize falls back to its default — so a client that never read this page still paginates instead of failing. Decimal values are rounded down. A page past the last one returns an empty items array with the real total.

Request​

Responses​

Leads retrieved successfully