Actions58
- Lead Management Actions
- User Agent Management Actions
- Campaign Management Actions
- Phone DID Management Actions
- List Management Actions
- Reporting Monitoring Actions
- System Info Actions
- Other Operations Actions
Lead Management → Lead Search
AI-generatedSummary
Search leads in VICIdial using a specified phone number and other optional filters.
Inputs
- baseURL (required) — Base VICIdial URL (no trailing /vicidial portion)
- function (required) — API function name (auto-filled, defaults to 'lead_search')
- user — User from the VICIdial credential
- pass — Password from the VICIdial credential
- source — Defaults to the source defined in the VICIdial credential
- phone_number (required) — Phone number (6-16 digits) to search for leads.
- records — Optional field to specify number of records to return.
- archived_lead — Specify if searching archived leads (default is 'N').
- header — Include header in output (default is 'NO').
- requestOptions — Advanced request configuration options.
Output shape
a list of lead records that match the specified phone number.
Response includes lead details based on the provided input parameters. Ensure that the phone number meets the digit requirements.