Actions26
Lead → Get Leads
AI-generatedSummary
Retrieves leads from a WebsitePublisher project with optional filtering and pagination.
Inputs
- leadFilters — A collection of filters to narrow the search results.
- leadFilters.status — Filter leads by status (All, New, Contacted, Converted).
- leadFilters.formName — Filter leads by the name of the form that captured them.
- leadFilters.dateFrom — Filter leads from this date (YYYY-MM-DD).
- leadFilters.dateTo — Filter leads until this date (YYYY-MM-DD).
- leadFilters.page — Page number for pagination (minimum 1).
- leadFilters.perPage — Number of leads per page (maximum 100).
- requestOptions — A collection of request options.
- requestOptions.batching — Configuration for batching items to throttle requests.
- requestOptions.batching.batchSize — Number of items per batch. -1 to disable batching.
- requestOptions.batching.batchInterval — Time in milliseconds between batches of requests.
- requestOptions.allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible.
- requestOptions.proxy — HTTP proxy to use for the request.
- requestOptions.timeout — Time in milliseconds to wait for the server to send response headers before aborting the request.
Output shape
A list of items, each representing a lead with its data.
The data shape of each lead item is determined by the specific lead fields configured in the WebsitePublisher project; it is not provided in the node configuration.
Examples
Example 1: Retrieve all leads from the last 30 days
Set Date From to 30 days ago and Date To to today. Leave other filters empty.
Example 2: Retrieve only new leads captured by a specific form
Set Status to 'New' and Form Name to the specific form ID.
Example 3: Paginate through results to retrieve 100 leads at a time
Set Per Page to 100 and Page Number to the desired page number.