INPUT_OBJECT

LeadFilterInput

Filter conditions for Lead records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

link GraphQL Schema definition

  • input LeadFilterInput {
  • # Matches records that meet at least one of the listed filters.
  • OR: [LeadFilterInput!]
  • # Matches records that meet all of the listed filters.
  • AND: [LeadFilterInput!]
  • # Matches records that do not meet this filter.
  • NOT: LeadFilterInput
  • # Search term matched against the fields that the global search covers for this
  • # entity.
  • globalSearchQuery: String
  • # Unique identifier of entity.
  • id: EntityFilterStringField
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: EntityFilterDateTimeField
  • # Creation time.
  • created: EntityFilterDateTimeField
  • # Id of the currency exchange rate list applied to this lead.
  • currencyExchangeRatesListId: EntityFilterStringField
  • # Free-form description of the lead.
  • description: EntityFilterStringField
  • # True when the lead has been archived (lost). Archived leads remain readable but
  • # are hidden from active lists and cannot be edited until reactivated.
  • isArchived: Boolean
  • # User-set colored flag used to highlight the lead in lists and reports.
  • labelFlag: LabelFlagEnumFilterInput
  • # Time when an AI-suggested buying center was last applied to this lead.
  • lastAiBuyingCenterApplied: EntityFilterDateTimeField
  • # Id of the lead source recording how the lead originated (e.g. Website, Referral,
  • # Trade Show).
  • leadSourceId: EntityFilterStringField
  • # Id of the lead type that classifies the lead and drives which form, fields and
  • # lead process apply.
  • leadTypeId: EntityFilterStringField
  • # Name of the entity and its default text representation.
  • name: EntityFilterStringField
  • # Id of the lead owner.
  • ownerId: EntityFilterStringField
  • # Free-text company email captured at lead creation when no Account record has
  • # been linked yet.
  • quickAccountEmail: EntityFilterStringField
  • # Free-text company name captured at lead creation when no Account record has been
  • # linked yet.
  • quickAccountName: EntityFilterStringField
  • # Free-text company phone captured at lead creation when no Account record has
  • # been linked yet.
  • quickAccountPhone: EntityFilterStringField
  • # Free-text contact name captured at lead creation when no Contact record has been
  • # linked yet.
  • quickContactName: EntityFilterStringField
  • # Free-text contact email captured at lead creation when no Contact record has
  • # been linked yet.
  • quickEmail: EntityFilterStringField
  • # Free-text contact phone captured at lead creation when no Contact record has
  • # been linked yet.
  • quickPhone: EntityFilterStringField
  • # Qualitative ranking score (1-10) the user assigns to indicate the strength of
  • # the lead.
  • ranking: EntityFilterNumberField
  • # Free-form note explaining why the lead was archived (lost). Captured alongside
  • # reasonOfClose.
  • reasonOfCloseDescription: EntityFilterStringField
  • # Id of the reason recorded when the lead is archived (lost), or empty when none
  • # was given.
  • reasonOfCloseId: EntityFilterStringField
  • # Sharing model applied on top of the owner/unit visibility (e.g. shared with
  • # selected sales units or selected users). The matching sharingUnits /
  • # sharingClients lists control who is granted access.
  • shareMode: ShareModeEnumFilterInput
  • # Id of the lead process step.
  • stepId: EntityFilterStringField
  • # Discriminator identifying the concrete record type — always "lead" for Lead
  • # records. Read-only; useful when consuming polymorphic LeadOppty results.
  • tableName: EntityFilterStringField
  • # Id of the sales unit.
  • unitId: EntityFilterStringField
  • # Revision when entity was lastly changed.
  • revision: EntityFilterNumberField
  • # Current status of the lead (Open, Lost, Qualified). Read-only; derived from the
  • # archived flag and lifecycle events.
  • status: LeadStatusEnumFilterInput
  • # Number of email sequences this record is currently actively enrolled in
  • # (soft-deleted or ended enrollments are not counted).
  • enrolledEmailSequences: Int
  • # Matches records related to at least one of the listed records.
  • relatedEntities: [EntityFilterRelatedField]
  • # Conditions on custom fields, each identified by its api name. All listed
  • # conditions must match.
  • withCustom: [CustomField!]
  • # Currency exchange rate list used to convert monetary fields linked to this lead.
  • # Empty to inherit the team space default. Matches records where a related record
  • # meets these conditions.
  • currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput
  • # How the lead originated (e.g. Website, Referral, Trade Show). Configurable per
  • # team space. Matches records where a related record meets these conditions.
  • leadSource: DataFilterInput
  • # Lead type that classifies this lead. Lead types are configurable per team space
  • # and drive which form, fields and lead process apply. Matches records where a
  • # related record meets these conditions.
  • leadType: LeadTypeFilterInput
  • # Sales user who owns this lead. May be empty when the lead is unassigned and
  • # available for take-over. Matches records where a related record meets these
  • # conditions.
  • owner: ClientFilterInput
  • # Configurable reason recorded when the lead is archived (lost). Required when the
  • # lost form mandates it. Matches records where a related record meets these
  • # conditions.
  • reasonOfClose: DataFilterInput
  • # Step in the lead process the lead is currently in. Matches records where a
  • # related record meets these conditions.
  • step: StepFilterInput
  • # Sales unit this lead is assigned to. Determines which team members can see the
  • # record under unit-based sharing. Matches records where a related record meets
  • # these conditions.
  • unit: SalesUnitFilterInput
  • # Primary contact of this lead. Set automatically from the contact relation marked
  • # as primary. Matches records where a related record meets these conditions.
  • primaryContact: ContactFilterInput
  • # Primary account of this lead. Set automatically from the account relation marked
  • # as primary. Matches records where a related record meets these conditions.
  • primaryAccount: AccountFilterInput
  • # Contacts linked to this lead, including their roles and org-chart positions.
  • # Matches records where a related record meets these conditions.
  • contactRelations: LeadOpptyContactRelationFilterInput
  • # Accounts linked to this lead, including the primary-account flag. Matches
  • # records where a related record meets these conditions.
  • accountRelations: LeadOpptyAccountRelationFilterInput
  • # Sales units that have been granted shared access to this lead. Editable only
  • # when shareMode allows unit sharing. Matches records where a related record meets
  • # these conditions.
  • sharingUnits: LeadOpptySharingSalesUnitRelationFilterInput
  • # Users that have been granted shared access to this lead. Editable only when
  • # shareMode allows user sharing. Matches records where a related record meets
  • # these conditions.
  • sharingClients: LeadOpptySharingClientRelationFilterInput
  • # Documents linked to this lead. Matches records where a related record meets
  • # these conditions.
  • documents: CloudObjectRelationFilterInput
  • # Tag labels applied to this lead. Matches records where a related record meets
  • # these conditions.
  • tags: TagRelationFilterInput
  • # Saved view profiles this lead currently matches. Matches records where a related
  • # record meets these conditions.
  • staticProfiles: ProfileRelationFilterInput
  • }

link Require by