List the agent's lead fields
list_lead_fieldsList the agent's lead fields
The agent's lead form in display order. The field keyed status lists the agent's lead
statuses as its options. If the list has no status field, or that field has no
options, the agent uses the statuses new, processing and completed, and a new lead
starts in new. Fields with built_in: false are the ones your team added; their keys
are what custom_fields is for, and createLeadField, updateLeadField and
deleteLeadField change them. Of the built-in fields, which the API can't change,
name, phone, summary and status are the lead's writable properties,
assigned_to is set with assignLead, created_at is read-only, and notes is the
contact's timeline (listContactNotes). The API doesn't check custom_fields against
this list (keys, value types, options or required), so validate before you write.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| agent_id | Yes | The agent the resource belongs to. Another company's agent, or the nil UUID, is `404 agent_not_found`; an agent outside the key's agent list is `403 agent_not_authorized`. |