Get Leads
hyros_get_leadsSearch and retrieve Hyros leads by email, phone, tag, stage, or date to find customers, check their tags and funnel stage, and sync changes into other systems.
Instructions
Search and retrieve leads from Hyros. Filter by email, phone, tag, stage, join date, or last-updated date. Use this to find customers, check their tags and current funnel stage, and sync changes into another system.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Comma-separated lead IDs to retrieve (max 50) | |
| tags | No | Comma-separated tag names (max 50). Returns leads matching ANY of them. Tags must include their prefix, e.g. @california or !florida. | |
| stage | No | Comma-separated stage names (max 50). Returns leads whose current stage matches ANY of them. | |
| emails | No | Comma-separated emails or email prefixes to search (max 50) | |
| pageId | No | Page ID for pagination (from nextPageId in previous response) | |
| phones | No | Comma-separated phone numbers (max 50). Matches on trailing digits, so formatting and country codes are tolerated. Finds leads that also have an email. | |
| toDate | No | End of the JOIN date range, ISO 8601 (e.g. 2024-01-31T23:59:59-05:00) | |
| fromDate | No | Start of the JOIN date range, ISO 8601 (e.g. 2024-01-01T00:00:00-05:00) | |
| pageSize | No | Number of results per page (1-250, default 50) | |
| updatedToDate | No | Only leads modified on or before this date, ISO 8601 | |
| updatedFromDate | No | Only leads modified on or after this date, ISO 8601. Use this for incremental sync: fromDate/toDate only see the join date and miss re-tagged or re-staged leads. |