Lead

A Lead: an Account plus the Contact(s) being pursued, carrying the properties of the pursuit itself rather than of the people involved.

type Lead {
  id: ID!
  name: String
  description: String
  account: Account
  owner: User
  is_closed: Boolean
  converted_at: DateTime
  converted_opportunity_id: ID
  created_at: DateTime!
  created_by: User
  updated_at: DateTime!
  updated_by: User
  fields: [LeadField!]!
  contacts: [LeadContact!]!
}

Fields

Lead.id ● ID! non-null scalar

Lead.name ● String scalar

Lead.description ● String scalar

Lead.account ● Account object

The organisation being pursued. Every Lead has one — a Contact without a company is given a per-product placeholder.

Lead.owner ● User object

Lead.is_closed ● Boolean scalar

Whether the pursuit has ended, derived from the stage's settings rather than set directly.

Lead.converted_at ● DateTime scalar

When this Lead became an Opportunity. Null means it has not converted.

Lead.converted_opportunity_id ● ID scalar

Lead.created_at ● DateTime! non-null scalar

Lead.created_by ● User object

Lead.updated_at ● DateTime! non-null scalar

Lead.updated_by ● User object

Lead.fields ● [LeadField!]! non-null object

Every standard and custom field, each carrying this Lead's value for it.

Lead.contacts ● [LeadContact!]! non-null object

The people attached to this Lead, with their role and which one is primary.

Returned By

createLead mutation ● deleteLead mutation ● lead query ● updateLead mutation

Member Of

Contact object ● LeadsResponse object