INPUT_OBJECT

LeadOrderByInput

Sorting of Lead records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

link GraphQL Schema definition

  • input LeadOrderByInput {
  • # Unique identifier of entity.
  • id: OrderByEnum
  • # Specifies if the entity is considered deleted.
  • isDeleted: OrderByEnum
  • # Last modification time.
  • modified: OrderByEnum
  • # Creation time.
  • created: OrderByEnum
  • # Currency exchange rate list used to convert monetary fields linked to this lead.
  • # Empty to inherit the team space default. Sorts by fields of the related record,
  • # listed in order of priority.
  • currencyExchangeRatesList: [CurrencyExchangeRatesListOrderByNestedInput!]
  • # How the lead originated (e.g. Website, Referral, Trade Show). Configurable per
  • # team space. Sorts by fields of the related record, listed in order of priority.
  • leadSource: [DataOrderByNestedInput!]
  • # Lead type that classifies this lead. Lead types are configurable per team space
  • # and drive which form, fields and lead process apply. Sorts by fields of the
  • # related record, listed in order of priority.
  • leadType: [LeadTypeOrderByNestedInput!]
  • # Sales user who owns this lead. May be empty when the lead is unassigned and
  • # available for take-over. Sorts by fields of the related record, listed in order
  • # of priority.
  • owner: [ClientOrderByNestedInput!]
  • # Configurable reason recorded when the lead is archived (lost). Required when the
  • # lost form mandates it. Sorts by fields of the related record, listed in order of
  • # priority.
  • reasonOfClose: [DataOrderByNestedInput!]
  • # Step in the lead process the lead is currently in. Sorts by fields of the
  • # related record, listed in order of priority.
  • step: [StepOrderByNestedInput!]
  • # Sales unit this lead is assigned to. Determines which team members can see the
  • # record under unit-based sharing. Sorts by fields of the related record, listed
  • # in order of priority.
  • unit: [SalesUnitOrderByNestedInput!]
  • # Id of the currency exchange rate list applied to this lead.
  • currencyExchangeRatesListId: OrderByEnum
  • # Free-form description of the lead.
  • description: OrderByEnum
  • # 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: OrderByEnum
  • # User-set colored flag used to highlight the lead in lists and reports.
  • labelFlag: OrderByEnum
  • # Id of the lead source recording how the lead originated (e.g. Website, Referral,
  • # Trade Show).
  • leadSourceId: OrderByEnum
  • # Id of the lead type that classifies the lead and drives which form, fields and
  • # lead process apply.
  • leadTypeId: OrderByEnum
  • # Name of the entity and its default text representation.
  • name: OrderByEnum
  • # Id of the lead owner.
  • ownerId: OrderByEnum
  • # Free-text company email captured at lead creation when no Account record has
  • # been linked yet.
  • quickAccountEmail: OrderByEnum
  • # Free-text company name captured at lead creation when no Account record has been
  • # linked yet.
  • quickAccountName: OrderByEnum
  • # Free-text company phone captured at lead creation when no Account record has
  • # been linked yet.
  • quickAccountPhone: OrderByEnum
  • # Free-text contact name captured at lead creation when no Contact record has been
  • # linked yet.
  • quickContactName: OrderByEnum
  • # Free-text contact email captured at lead creation when no Contact record has
  • # been linked yet.
  • quickEmail: OrderByEnum
  • # Free-text contact phone captured at lead creation when no Contact record has
  • # been linked yet.
  • quickPhone: OrderByEnum
  • # Qualitative ranking score (1-10) the user assigns to indicate the strength of
  • # the lead.
  • ranking: OrderByEnum
  • # Free-form note explaining why the lead was archived (lost). Captured alongside
  • # reasonOfClose.
  • reasonOfCloseDescription: OrderByEnum
  • # Id of the reason recorded when the lead is archived (lost), or empty when none
  • # was given.
  • reasonOfCloseId: OrderByEnum
  • # 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: OrderByEnum
  • # Id of the lead process step.
  • stepId: OrderByEnum
  • # Id of the sales unit.
  • unitId: OrderByEnum
  • # Revision when entity was lastly changed.
  • revision: OrderByEnum
  • # Current status of the lead (Open, Lost, Qualified). Read-only; derived from the
  • # archived flag and lifecycle events.
  • status: OrderByEnum
  • # Number of email sequences this record is currently actively enrolled in
  • # (soft-deleted or ended enrollments are not counted).
  • enrolledEmailSequences: OrderByEnum
  • # Sorts records by whether they are related to the listed records.
  • relatedEntities: CommonEntityRepositoryOrderByEntityRelationField
  • # Sorts by a custom field.
  • withCustom: CommonEntityRepositoryOrderByCustomField
  • }