Skip to main content

List leads

GET 
/partner/lead

Returns a paginated, summarised list of your leads — six fields per row, newest first. This is the grid view: it deliberately carries no personal data beyond what identifies the row. For contact details use Get lead details, and for the evaluation itself use Get an evaluation by lead id.

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 whose only evaluation is BNPL are excluded, matching the scope of the other endpoints in this group.
  • 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 itidPreAprobacion: null
expiredreturns it404 for the whole lead

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 a non-numeric page or pageSize falls back to its default — so a client that never read this page still paginates instead of failing.

Request​

Responses​

Leads retrieved successfully