SuperHippo AI Voice Agents icon

SuperHippo AI Voice Agents

Manage leads and calls on the SuperHippo AI Voice Agent

Actions18

Lead → List Leads

AI-generated

Summary

Retrieve a paginated list of leads optionally filtered by criteria such as agent ID, date range, lead status, source, deletion inclusion, search text, and timezone.

Inputs

  • Page — Page number for results pagination, minimum 1, defaults to 1.
  • Page Size — Number of leads per page, minimum 1 and maximum 5000, defaults to 10.
  • Filters — Optional filters to narrow down results: Agent ID (string), Date Range (string, format start:end), Include Deleted (boolean), Lead Status (Contacted or Not Contacted), Search Text (string), Source (Auto Generated, CSV Import, GHL Import, HubSpot Import, Manual Entry), and Timezone (string, e.g. 'America/New_York').

Output shape

a list of lead records, each representing a lead matching the filter criteria and pagination settings

The leads are returned based on the applied query parameters reflecting pagination and filtering. The exact shape of each lead record depends on the API's response schema. Pagination is controlled via 'page' and 'pageSize' inputs. Optional filters refine the results; if omitted, defaults apply.

Examples

Example 1: List first 10 leads not yet contacted

Set 'Page' to 1, 'Page Size' to 10, and 'Lead Status' filter to 'Not Contacted'.

Example 2: Retrieve leads assigned to a specific agent within a date range

Define 'Agent ID', specify 'Date Range' in 'YYYY-MM-DD:YYYY-MM-DD' format under filters, and adjust 'Page' and 'Page Size' as needed.

Links

Discussion