Leadify V3Install

Summary

Retrieve leads from a specified group with optional pagination, filters, and additional fields.

Inputs

• groupId (required) — The ID of the lead group to retrieve leads from. Find it in Leadify URL or group settings.
• limit — Max number of results to return
• page — Page number to retrieve (starts at 1)
• noPagination — Whether to disable pagination and return all results (use with caution on large datasets)
• advancedOptions — Additional filtering and search options
• additionalFields — Additional request-level settings such as timeout
• requestOptions — Node-level request configuration including batch settings, proxy, and SSL options

Output shape

a list of lead objects

Pagination is applied unless noPagination is true; optional filter fields may be omitted; errors follow the API's standard error envelope.

Examples

Example 1: Fetch the first page of leads from a group

groupId = cl123456789, limit = 50, page = 1

Example 2: Retrieve all leads in a group without pagination

groupId = cl123456789, noPagination = true

Example 3: Search leads with a filter expression

groupId = cl123456789, advancedOptions.search = "Acme", advancedOptions.filterExpression = "filter[status][equals]=qualified"