OBJECT
LeadEntity

GraphQL Schema definition

type LeadEntity {
# Arguments
#   apiNames: Api names of custom fields to retrieve. All are 
#   returned if not set.
customFields(apiNames: [String!]): JSONString! 
#   Deferred property. Will return data only if called via get_by_id. Otherwise null 
#   or empty array is used.
pendingScheduledActions: Int 
#   Tells if the entity instance is protected against delete (Entities that need to 
#   be present in the system at any time). Delete action still may fail if entity is 
#   deletable, due some other additional validations.
isDeleteProtected: Boolean! 
#   Unique identifier of entity.
id: ID! 
#   Specifies if the entity is considered deleted.
isDeleted: Boolean 
#   Last modification time.
modified: DateTime 
#   Creation time.
created: DateTime 
#   Currency exchange rate list used to convert monetary fields linked to this lead. 
#   Empty to inherit the team space default.
currencyExchangeRatesList: CurrencyExchangeRatesListEntity 
#   How the lead originated (e.g. Website, Referral, Trade Show). Configurable per 
#   team space.
leadSource: DataEntity 
#   Lead type that classifies this lead. Lead types are configurable per team space 
#   and drive which form, fields and lead process apply.
leadType: LeadTypeEntity 
#   Sales user who owns this lead. May be empty when the lead is unassigned and 
#   available for take-over.
owner: ClientEntity 
#   Configurable reason recorded when the lead is archived (lost). Required when the 
#   lost form mandates it.
reasonOfClose: DataEntity 
#   Step in the lead process the lead is currently in.
step: StepEntity 
#   Sales unit this lead is assigned to. Determines which team members can see the 
#   record under unit-based sharing.
unit: SalesUnitEntity 
#   Id of the currency exchange rate list applied to this lead.
currencyExchangeRatesListId: ID 
#   Free-form description of the lead.
description: String 
#   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: Int 
#   Id of the lead source.
leadSourceId: ID 
#   Id of the lead type.
leadTypeId: ID 
#   Name of the entity and its default text representation.
name: String! 
#   Id of the lead owner.
ownerId: ID 
#   Free-text company email captured at lead creation when no Account record has 
#   been linked yet.
quickAccountEmail: String 
#   Free-text company name captured at lead creation when no Account record has been 
#   linked yet.
quickAccountName: String 
#   Free-text company phone captured at lead creation when no Account record has 
#   been linked yet.
quickAccountPhone: String 
#   Free-text contact name captured at lead creation when no Contact record has been 
#   linked yet.
quickContactName: String 
#   Free-text contact email captured at lead creation when no Contact record has 
#   been linked yet.
quickEmail: String 
#   Free-text contact phone captured at lead creation when no Contact record has 
#   been linked yet.
quickPhone: String 
#   Qualitative ranking score (1-10) the user assigns to indicate the strength of 
#   the lead.
ranking: Int 
#   Free-form note explaining why the lead was archived (lost). Captured alongside 
#   reason_of_close.
reasonOfCloseDescription: String 
#   Id of the reason-of-close value.
reasonOfCloseId: ID 
#   Sharing model applied on top of the owner/unit visibility (e.g. shared with 
#   selected sales units or selected users). The matching sharing_units / 
#   sharing_clients lists control who is granted access.
shareMode: ShareModeEnum 
#   Id of the lead process step.
stepId: ID 
#   Discriminator identifying the concrete record type — always "lead" for Lead 
#   records. Read-only; useful when consuming polymorphic LeadOppty results.
tableName: String! 
#   Id of the sales unit.
unitId: ID 
#   Revision when entity was lastly changed.
revision: Int 
#   Primary contact of this lead. Set automatically from the contact relation marked 
#   as primary.
primaryContact: ContactEntity 
#   Primary account of this lead. Set automatically from the account relation marked 
#   as primary.
primaryAccount: AccountEntity 
#   Contacts linked to this lead, including their roles and org-chart positions.
# 
# Arguments
#   filter: Filter Contact relations by target Contact attributes.
#   filterEdge: Filter LeadOpptyContactRelation relations by edge 
#   (relation) LeadOpptyContactRelation attributes.
#   orderBy: Order Contact relations by target Contact attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
contactRelations(
filter: ContactFilterInput,
filterEdge: LeadOpptyContactRelationFilterInput,
orderBy: [ContactOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): LeadOpptyContactRelationEntityConnection 
#   Accounts linked to this lead, including the primary-account flag.
# 
# Arguments
#   filter: Filter Account relations by target Account attributes.
#   filterEdge: Filter LeadOpptyAccountRelation relations by edge 
#   (relation) LeadOpptyAccountRelation attributes.
#   orderBy: Order Account relations by target Account attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
accountRelations(
filter: AccountFilterInput,
filterEdge: LeadOpptyAccountRelationFilterInput,
orderBy: [AccountOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): LeadOpptyAccountRelationEntityConnection 
#   Current status of the lead (Open, Lost, Qualified). Read-only; derived from the 
#   archived flag and lifecycle events.
status: LeadStatusEnum! 
#   Sales units that have been granted shared access to this lead. Editable only 
#   when share_mode allows unit sharing.
# 
# Arguments
#   filter: Filter SalesUnit relations by target SalesUnit 
#   attributes.
#   filterEdge: Filter LeadOpptySharingSalesUnitRelation relations 
#   by edge (relation) LeadOpptySharingSalesUnitRelation attributes.
#   orderBy: Order SalesUnit relations by target SalesUnit 
#   attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
sharingUnits(
filter: SalesUnitFilterInput,
filterEdge: LeadOpptySharingSalesUnitRelationFilterInput,
orderBy: [SalesUnitOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): LeadOpptySharingSalesUnitRelationEntityConnection 
#   Users that have been granted shared access to this lead. Editable only when 
#   share_mode allows user sharing.
# 
# Arguments
#   filter: Filter Client relations by target Client attributes.
#   filterEdge: Filter LeadOpptySharingClientRelation relations by 
#   edge (relation) LeadOpptySharingClientRelation attributes.
#   orderBy: Order Client relations by target Client attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
sharingClients(
filter: ClientFilterInput,
filterEdge: LeadOpptySharingClientRelationFilterInput,
orderBy: [ClientOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): LeadOpptySharingClientRelationEntityConnection 
#   Documents linked to this lead.
# 
# Arguments
#   filter: Filter CloudObject relations by target CloudObject 
#   attributes.
#   filterEdge: Filter CloudObjectRelation relations by edge 
#   (relation) CloudObjectRelation attributes.
#   orderBy: Order CloudObject relations by target CloudObject 
#   attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
documents(
filter: CloudObjectFilterInput,
filterEdge: CloudObjectRelationFilterInput,
orderBy: [CloudObjectOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): CloudObjectRelationEntityConnection 
#   Number of email sequences this record is currently actively enrolled in 
#   (soft-deleted or ended enrollments are not counted).
enrolledEmailSequences: Int! 
#   Tag labels applied to this lead.
# 
# Arguments
#   filter: Filter Tag relations by target Tag attributes.
#   filterEdge: Filter TagRelation relations by edge (relation) 
#   TagRelation attributes.
#   orderBy: Order Tag relations by target Tag attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
tags(
filter: TagFilterInput,
filterEdge: TagRelationFilterInput,
orderBy: [TagOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): TagRelationEntityConnection 
#   Saved view profiles this lead currently matches.
# 
# Arguments
#   filter: Filter Profile relations by target Profile attributes.
#   filterEdge: Filter ProfileRelation relations by edge (relation) 
#   ProfileRelation attributes.
#   orderBy: Order Profile relations by target Profile attributes.
#   includeDeleted: Returns deleted target records as well. Default 
#   is true.
#   before: Cursor until which to take entities to result set.
#   after: Cursor after which to start taking entities to result 
#   set.
#   first: Number of entities to return from beginning of the 
#   result set.
#   last: Return only the "last" number of entities from result 
#   set.
staticProfiles(
filter: ProfileFilterInput,
filterEdge: ProfileRelationFilterInput,
orderBy: [ProfileOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ProfileRelationEntityConnection 
#   Timestamp of when the lead was qualified, taken from the matching KPI event. 
#   Empty for leads that have not been qualified. Read-only.
qualifyDate: DateTime 
#   Number of days the lead has been sitting in its current pipeline step. 
#   Read-only; computed by Coevera from the most recent move event.
daysInStep: Int! 
#   Deferred property. Will return data only if called via get_by_id. Otherwise null 
#   or empty array is used.
fitness: WarningLevelEnum! 
#   Deferred property. Will return data only if called via get_by_id. Otherwise null 
#   or empty array is used.
fitnessDescription: FitnessDescription! 
#   True when the current authenticated user has marked this lead as favorite. 
#   Per-user.
isFavorite: Boolean! 
#   Timestamp of when the lead was archived (lost). Setting it adjusts the 
#   underlying loss event; empty for leads that have not been archived.
lostDate: DateTime 
#   Display version of the lead name, used in lists and references.
formattedName: String! 
#   Lead scoring summary, combining the percentile and current scoring state. 
#   Read-only; computed by Coevera.
scoring: EntityScoringResult 
#   Deferred property. Will return data only if called via get_by_id. Otherwise null 
#   or empty array is used.
viewerIdsPerSalesUnit: [UUID!]! 
#   Timestamp of the most recent modification made by an end user (excluding system 
#   changes). Read-only; computed by Coevera.
modifiedByUser: DateTime 
#   Checks which permissions current user has on concrete entity instance.
# 
# Arguments
#   permissions: [Not documented]
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
# Arguments
#   entityType: [Not documented]
relatedEntitiesDrilldown(entityType: EntityNameEnum!): CompactViewDrilldownModel! 
# Arguments
#   ids: [Not documented]
charts(ids: [UUID!]!): [DashboardChartData!] 
# Arguments
#   id: [Not documented]
#   seriesIndex: [Not documented]
#   itemIndex: [Not documented]
chartsDrilldown(id: UUID!, seriesIndex: Int, itemIndex: Int): CompactViewDrilldownModel! 
# Arguments
#   ids: Null to load all fields defined on InterfacePreview entity
#   first: [Not documented]
fields(ids: [UUID!], first: Int): [InterfaceFieldData]! 
# Arguments
#   stepChecklistIds: [Not documented]
stepChecklists(stepChecklistIds: [UUID]): [StepChecklistActivityItem]! 
approval: ApprovalEntity 
}
LeadEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
