List leads
idx_list_leadsList the account's leads (website registrants) with contact details, status, agent owner, and last viewed listings and searches. A reply holds up to 500 leads; pass offset to page on and look for pagination information in the reply. Filter by a time window on signup, edit, login or activity date. Uses one of the key's hourly API accesses. GET /leads/lead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Only return these fields (IDX `rf`); ["*"] returns every available field. Narrow it to save API size. | |
| offset | No | Items to skip from the beginning (default 0). | |
| sort_by | No | Sort by creation order, asc or desc. | |
| interval | No | Hours of data to return, counted back from start_datetime (default: now). 0.0166 (one minute) to 168; decimals allowed. IDX default when omitted: 1 hour; pass up to 168 for one week. | |
| date_type | No | Which date the time window applies to (default subscribeDate). | |
| start_datetime | No | Where the interval starts counting back (the newest moment wanted). Default: now. ISO 8601 with a timezone. |