List leads you sent
Leads in the key holder’s Leads Sent scope. The account sees agreements it holds. A parent account sees the accounts under it. Leads only received as the partner are not included. Queued rows stay in the list.
page defaults to 1. A missing or invalid page uses 1. pageSize defaults to 25 and is clamped to 50. A missing or invalid pageSize uses 25.
Each item has the contact fields Leads Sent shows. Stored status completed is returned as won. delivery is queued when the lead is not shared, otherwise delivered. A queued item includes queuedReason.
/api/leadsX-CM-API-KEYAPI key · headerrequiredAccount key from Integrations. Keys use the cm_ prefix.
pageintegerPage number. Defaults to 1.
pageSizeintegerPage size. Defaults to 25 and is clamped to 50.
A page of leads this account sent.
itemsLead[]requiredShow propertiesHide properties
Leadidstringrequirednamestringrequiredemailstringrequiredphonestringrequiredlocationstring | nullrequirednotesstring | nullrequiredcategorystringrequiredservicestringrequiredleadIntentstringrequiredhirenegotiationcomparisonsharedbooleanrequireddeliverystringrequireddeliveredqueuedqueuedReasonQueuedReasonbudget_exceededpayment_failedoriginstringrequirednetworkhome_prepestimatordashboardsuresendcoapimcpstatusstringrequiredStored status completed is returned as won.
pendingcontactedattemptedToContactestimatingscheduledwonlostpartnerLeadPartyrequiredShow propertiesHide properties
idstringrequirednamestring | nullrequiredsentByLeadParty | nullrequiredShow propertiesHide properties
idstringrequirednamestring | nullrequirednulljobValuenumber | nullrequiredcreatedAtstring<date-time>requiredtotalintegerrequiredpageintegerrequiredpageSizeintegerrequiredhasMorebooleanrequiredThe key is missing or unknown.
errorstringrequiredThe key cannot send leads.
errorstringrequired