VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

List Management → List Custom Fields

AI-generated

Summary

Retrieve custom fields for a specified list in VICIdial.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion).
  • function (required) — API function name, auto-filled as 'list_custom_fields'.
  • user — Username from VICIdial credentials.
  • pass — Password from VICIdial credentials.
  • source — Source from VICIdial credentials.
  • list_id (required) — ID of the list to retrieve custom fields from.
  • stage — Output format, default is 'pipe'.
  • header — Include header in output, default is 'NO'.
  • custom_order — Order options for custom fields.
  • requestOptions — Collection of request options, including batching and timeout settings.

Output shape

a list of custom fields associated with the specified list in VICIdial.

The response includes the custom fields in the specified format (CSV, JSON, etc.). The presence of headers in the response can be configured.

Discussion