Skip to content
Comarketing
Esc
↑↓navigate↵open⌘Jpreview

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.

GET/api/leads
Authorization
X-CM-API-KEYAPI key · headerrequired

Account key from Integrations. Keys use the cm_ prefix.

Query parameters
pageinteger

Page number. Defaults to 1.

min 1 · default: 1
pageSizeinteger

Page size. Defaults to 25 and is clamped to 50.

min 1 · max 50 · default: 25
Responses
200

A page of leads this account sent.

itemsLead[]required
Show properties
Array of Lead
idstringrequired
namestringrequired
emailstringrequired
phonestringrequired
locationstring | nullrequired
notesstring | nullrequired
categorystringrequired
servicestringrequired
leadIntentstringrequired
Allowed:hirenegotiationcomparison
sharedbooleanrequired
deliverystringrequired
Allowed:deliveredqueued
queuedReasonQueuedReason
Allowed:budget_exceededpayment_failed
originstringrequired
Allowed:networkhome_prepestimatordashboardsuresendcoapimcp
statusstringrequired

Stored status completed is returned as won.

Allowed:pendingcontactedattemptedToContactestimatingscheduledwonlost
partnerLeadPartyrequired
Show properties
idstringrequired
namestring | nullrequired
sentByLeadParty | nullrequired
Show properties
One of:
LeadParty
idstringrequired
namestring | nullrequired
null
null
jobValuenumber | nullrequired
createdAtstring<date-time>required
totalintegerrequired
pageintegerrequired
pageSizeintegerrequired
hasMorebooleanrequired
401

The key is missing or unknown.

errorstringrequired
403

The key cannot send leads.

errorstringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://www.comarketing.com/api/leads' \
  -H 'X-CM-API-KEY: YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "items": [],
  "total": 0,
  "page": 1,
  "pageSize": 25,
  "hasMore": false
}

Was this page helpful?