v9

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-01391555.5 KB

Customer REST

List active leads available to this key.

get/customer/leads

limitinteger

Number of items to return. The default is 50 and the maximum is 100.

cursorstring

Opaque cursor returned in page.nextCursor. Pass it unchanged with the same filters and sort. Incompatible cursors return validation_failed.

tier'UNQUALIFIED' | 'NURTURE' | 'QUALIFIED' | 'PRIORITY'

leadTiersstring

Comma-separated lead tiers. Accepts up to four values.

disposition'ACTIVE' | 'CLIENT' | 'BAD_LEAD'

dispositionsstring

Comma-separated dispositions. Accepts up to three values. Omitted dispositions default to ACTIVE.

minIcpMatchPercentinteger

maxIcpMatchPercentinteger

monitoredProfileIdstring uuid

monitoredProfileIdsstring

Comma-separated monitored profile IDs. Accepts up to 50 IDs.

postIdstring uuid

engagementType'LIKE' | 'COMMENT' | 'REPOST'

engagementTypesstring

Comma-separated engagement types. Accepts up to three values.

ownerIdstring uuid

ownerIdsstring

Comma-separated owner IDs. Accepts up to 50 IDs.

dateFromstring date-time

Inclusive start of the date range.

dateTostring date-time

Inclusive end of the date range.

querystring

companyNamesstring

Comma-separated company names. Accepts up to 25 values.

origin'agent' | 'watchlist' | 'all'

Safe lead origin. agent includes automated Agent and preview discovery; watchlist includes watched-profile and manual workflows.

Lead page. Contact fields are null unless the key has leads:contact_read.