WIwindmill-growth
Customer REST

List API-visible leads.

Changed on
get/customer/leads

Request

Query parameters

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' | 'POST_AUTHOR'
engagementTypesstring

Comma-separated engagement types. Accepts up to 4 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.

Response

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

Changes

  • 3dde15782092Revision changes
    • info

      added the new enum value POST_AUTHOR to the query request parameter engagementType

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property /// to the response with the status

  • e60dfaf3c445Revision changes
    • breaking

      the query request parameter tier was restricted to a list of enum values

    • breaking

      for the query request parameter limit, default value was changed from 25 to 50

    • warning

      for the query request parameter cursor, the maxLength was set to 256

    • info

      added the new optional query request parameter companyNames

    • info

      added the new optional query request parameter dateFrom

    • info

      added the new optional query request parameter dateTo

    • info

      added the new optional query request parameter disposition

    • info

      added the new optional query request parameter dispositions

    • info

      added the new optional query request parameter engagementType

    • info

      added the new optional query request parameter engagementTypes

    • info

      added the new optional query request parameter leadTiers

    • info

      added the new optional query request parameter maxIcpMatchPercent

    • info

      added the new optional query request parameter monitoredProfileId

    • info

      added the new optional query request parameter monitoredProfileIds

    • info

      added the new optional query request parameter origin

    • info

      added the new optional query request parameter ownerId

    • info

      added the new optional query request parameter ownerIds

    • info

      added the new optional query request parameter postId

    • info

      added the new optional query request parameter query

    • info

      added the new enum value NURTURE to the query request parameter tier

    • info

      added the new enum value PRIORITY to the query request parameter tier

    • info

      added the new enum value QUALIFIED to the query request parameter tier

    • info

      added the new enum value UNQUALIFIED to the query request parameter tier