Parallel AI icon

Parallel AI

Interact with Parallel AI

Actions537

Lead → List Field Options

AI-generated

Summary

List available field options for Lead resources, optionally including detailed descriptions and enum values for specific fields or groups.

Inputs

  • Company ID — Optional Company ID to specify context; this endpoint is free and can be called without it.
  • Describe — Boolean to enable detailed descriptions and inline enum options for fields.
  • Group — When Describe is true, scope the returned options to a specific group such as location, person, business, financial, housing, contact, or intent.
  • Field — Specify one field to list its options; with Describe true, returns that field's inline options; without Describe, returns that field's enumerated values; omit to list options for all fields.

Output shape

A JSON object containing enumerated options for Lead fields. The content varies based on the Describe flag and Field or Group parameters — it may include inline option descriptions grouped by field or general enumerations for fields.

If Describe is enabled, output includes detailed field descriptions and enum options grouped accordingly. Without Describe, output is basic enum values. The Company ID is optional and does not affect the output if omitted.

Examples

Example 1: List all Lead field options without description

Describe=false, no Field or Group specified, no Company ID.

Example 2: List options for a specific field with detailed descriptions

Describe=true, Field set to that field name.

Example 3: List options scoped to a group with detailed descriptions

Describe=true, Group set to one of the recognized groups.

Links

Discussion