Lead

Fields

agreements[Agreement]
appointments[Appointment]
assigneeUser

The user id of the organization member assigned to the lead.

buyerBuyer
buyers[Buyer]
checklists[Checklist]
companyString
contacts[Contact]
customEvents(filter:CustomEventsFilter)[CustomEvent]
customFields[CustomField]
deposits[Deposit]
dobDate

The lead's date of birth.

documents[BuyerDocument]
emailString

The email address of the lead.

emailInfoJson
escalationTickets[EscalationTicket]
events(filter:LeadEventsFilterfirst:Int)[Event]
falloutReasonFalloutReason
falloutReasonOtherString
firstNameString

Read-only field automatically derived from the name field by applying best-effort name parsing.

idID
importedBoolean
insertedAtNaiveDateTime
interactionTimingAnalysisLeadInteractionTimingAnalysis

The next-best-action recommendation for this lead: what to do, why, how urgent it is, and when. Calculated from the lead's complete interaction history and engagement patterns, and used as the system of record for follow-up prioritization.

isAgentBoolean

Indicates whether the lead themselves is an agent (not whether the lead is represented by an agent). A lead cannot be an agent (isAgent: true) and represented by an agent.

isRepresentedBoolean

Indicates whether the lead is represented. A lead cannot be an agent (isAgent: true) and represented by an agent.

lastInteractionAtNaiveDateTime

The date / time of the last interaction with the lead. This is inferred through text messages, emails, phone calls, and appointments.

lastNameString

Read-only field automatically derived from the name field by applying best-effort name parsing.

messages[ProjectMessage]

Returns a ProjectMessage union, which can be a ProjectContactMessage, ProjectDirectMessage and ProjectEmailMessage. Future iteration will support ProjectSMSMessage.

metadataJson
nameString

The name of the lead. This is intentionally flexible as to not require separate first and last names. More specific names are required for reservations, offers and purchases.

negotiations[Negotiation]

The lead's "Buy Now" negotiations.

notes(filter:LeadNotesFilterfirst:Int)[CommonLeadNote]
occupationString
offers[BindingOffer]
originLeadOrigin

Where the lead originated from. Edgewise will assign a value if not set; usually prefixed with EDGEWISE_.

personalizations[Personalization]
phoneString

The lead's phone number in E.164 format.

phoneCalls[PhoneCall]
preferencesLeadPreferences
preferredContactMethodPreferredContactMethod
preferredLanguagePreferredLanguage
projectProject
qualificationAnalysisLeadQualificationAnalysis
registeredAtNaiveDateTime

The date / time the lead was registered. This may be different than the insertedAt date / time if the lead was imported from a previous system.

relationshipStatusRelationshipStatus
relationships[LeadRelationship]
reservations[Reservation]

The lead's reservations. All "Buy Now" negotiations have an underlying reservation.

sourceString

The lead's source name. Derived from Project.LeadSource.name.

statusLeadStatus

The current status of the lead (eg. warm for a lead that you have active communication with).

subscribedBoolean
summaryLeadSummary

AI-generated summary of this lead, synthesized from everything Edgewise has on record: contact details, emails, SMS, notes, appointments, offers, and other activity. Regenerated whenever the lead is updated, so it always reflects the lead's current state.

tags[String]
tasks[Task]
tracking[TrackingEvent]
unsubscribedAtNaiveDateTime
updatedAtNaiveDateTime
userUser

Deprecated Fields

followedAtNaiveDateTime

Use subscribed instead.

secondarySourceLeadSource

Use source instead.

staleBoolean

Use interactionTimingAnalysis.urgency instead.