Urano icon

Urano

Interact with the Urano API

Lead → Get Many Leads

AI-generated

Summary

Retrieve multiple leads from the Urano system, optionally filtered by various client identifiers, dates, product, office, sales team, users, status, and activity filters.

Inputs

  • Identifier Type — Type of client identifier to filter leads by, such as Client CPF, Email, ID, Phone Number, Sales ID, or None for no identifier filter.
  • Identifier Value — Value corresponding to the chosen Identifier Type to filter leads.
  • Date Interval — Date range in format 'YYYY-mm-dd - YYYY-mm-dd' to filter leads according to the selected Date Interval Type.
  • Date Interval Type — Specifies which date field to filter leads on: Creation Date, Completion Date, or Last Classification Date; defaults to Creation Date.
  • Products — JSON array of Product IDs to filter leads by associated products.
  • Office — JSON array of Office IDs to filter leads by associated offices.
  • Sales Team — JSON array of Sales Team IDs to filter leads by associated sales teams.
  • SDR User — JSON array of SDR User IDs to filter leads created by specific SDRs.
  • Closer User — JSON array of Closer User IDs to filter leads handled by specific closers.
  • Status — JSON array of Status IDs to filter leads by their status.
  • Include Inactives — Boolean flag to include inactive leads in the results; defaults to false.
  • Only Inactives — Boolean flag to retrieve only inactive leads; defaults to false.
  • Special Filters — Select from predefined filters like All Expired Leads, Completed, My Expired Leads, Not Completed, Productive Status, or Unproductive Status; defaults to All Expired Leads.
  • Request Options — Options like batching, SSL ignore, proxy, and timeout settings to control request behavior and performance.

Output shape

a list of lead records matching the specified filters

Results are returned as a paginated array of lead objects from the '/oportunidades' endpoint, filtered based on the provided query string parameters. If filtering parameters are omitted, all leads may be returned. Filtering by JSON arrays expects valid JSON input for corresponding fields.

Links

Discussion