VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Lead Management → Lead Field Info

AI-generated

Summary

Retrieve specific field information for a lead from the VICIdial system.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion).
  • function (required) — API function name (auto-filled, defaults to 'lead_field_info').
  • user — User credential for VICIdial.
  • pass — Password credential for VICIdial.
  • source — Source defined in the VICIdial credential.
  • lead_id (required) — Lead ID for which field information is being requested.
  • field_name (required) — Field name of the lead to retrieve info for.
  • custom_fields — Specify 'Y' to include custom fields.
  • list_id — List ID associated with the lead.
  • archived_lead — Specify 'Y' to include archived leads.
  • requestOptions — Collection of request options like batching and timeout settings.

Output shape

a single record containing field information for the specified lead

Response will include various attributes based on the requested field; may vary depending on the configuration and specified parameters.

Discussion