VICIdialInstall

Summary

Searches for leads based on their status and date in the VICIdial system.

Inputs

• baseURL (required) — Base VICIdial URL (no trailing /vicidial portion).
• function (required) — API function name (auto-filled, set to 'lead_status_search').
• user — Comes from the VICIdial credential.
• pass — Comes from the VICIdial credential.
• source — Defaults to the source defined in the VICIdial credential.
• status (required) — The status of the leads to search.
• date (required) — Date in YYYY-MM-DD format.
• lead_id — Lead ID for a specific search.
• custom_fields — Indicate if custom fields should be included.
• list_id — ID of the list to restrict the search.
• archived_lead — Indicates whether to include archived leads.
• requestOptions — Collection of options for the request, such as batching, proxy, and timeout.

Output shape

a list of leads matching the specified status and date criteria.

Returned data includes lead information based on the filters applied, including possible pagination if the results exceed request limits.

Examples

Example 1: Search for leads with specified status and date

Provide the base URL, required status and date, and any applicable options such as lead ID.