v1

latestOpenAPI 3.1.02026-08-069158174.8 KB
CRM Service Calls

Paginated leads lookup by marketing source

Query leads by marketing source (lead_source) with pagination and journey tracking.

Search Options

  • lead_source: Required. The marketing source to filter by (exact match)
  • include_converted: Include leads converted to contacts (default: true)
  • include_disqualified: Include disqualified leads (default: false)

Pagination

  • page_size: Number of items per page (default: 50, max: 100)
  • page_num: Page number, 1-indexed (default: 1)

Privacy Notice

This endpoint returns only aggregate activity metrics per lead. It does NOT expose:

  • Names or personal identifying information
  • Actual comment content or details
  • Owner/assigned user information
  • Deal values or commission-sensitive data

Use Cases

  • Partner Analytics: View all leads from your marketing source
  • Journey Tracking: Track conversion progress of your leads
  • Performance Monitoring: Monitor lead-to-opportunity conversion rates

Inactivity Period

The inactivity_days parameter (default: 30) determines whether activity is considered "recent". The has_recent_activity field indicates if the most recent activity falls within this threshold.

post/crm/lookup/leads

Query parameters

page_sizeinteger

Number of leads per page

Number of leads per page

page_numinteger

Page number (1-indexed)

Page number (1-indexed)

inactivity_daysinteger

Number of days to consider for inactivity threshold

Number of days to consider for inactivity threshold

Request body

lead_sourcestring required

Marketing source / lead source to filter by

include_convertedboolean

Include leads that have been converted to contacts

include_disqualifiedboolean

Include disqualified/inactive leads

Response

Lookup successful

lead_sourcestring required

The marketing source that was queried

total_countinteger required

Total number of leads matching the query

page_sizeinteger required

Number of items per page

page_numinteger required

Current page number (1-indexed)

total_pagesinteger required

Total number of pages