Types: L
Each type links to the repository page that documents it; the types several repositories share are documented below, with their fields.
A B C D E F G H I J L M N O P Q R S T U V W X Y
LabelFlagEnum LabelFlagEnumFilterInput LastActivityInterval LastContactedDateProperty LeadAutoPrefill LeadDashboardProfile LeadDashboardProfileTab LeadDashboardProfileView LeadEntity LeadEntityConnection LeadEntityEdge LeadFilterInput LeadFilterTab LeadOpportunityEntity LeadOpportunityFilterTab LeadOpportunityPivotReportProfile LeadOpportunityProfileInterface LeadOpportunityReportProfileInterface LeadOpportunityRoleTab LeadOpportunityTableReportProfile LeadOpptyAccountRelationEntity LeadOpptyAccountRelationEntityConnection LeadOpptyAccountRelationEntityEdge LeadOpptyAccountRelationFilterInput LeadOpptyAccountRelationOrderByInput LeadOpptyAccountRelationRepository LeadOpptyContactGroupRelationEntity LeadOpptyContactGroupRelationEntityConnection LeadOpptyContactGroupRelationEntityEdge LeadOpptyContactGroupRelationFilterInput LeadOpptyContactGroupRelationOrderByInput LeadOpptyContactGroupRelationOrderByNestedInput LeadOpptyContactGroupRelationRepository LeadOpptyContactRelationEntity LeadOpptyContactRelationEntityConnection LeadOpptyContactRelationEntityEdge LeadOpptyContactRelationFilterInput LeadOpptyContactRelationOrderByInput LeadOpptyContactRelationOrderByNestedInput LeadOpptyContactRelationRepository LeadOpptyContactSalesRoleRelationEntity LeadOpptyContactSalesRoleRelationEntityConnection LeadOpptyContactSalesRoleRelationEntityEdge LeadOpptyContactSalesRoleRelationFilterInput LeadOpptyContactSalesRoleRelationOrderByInput LeadOpptyContactSalesRoleRelationRepository LeadOpptyDataExRelationEntity LeadOpptyDataExRelationEntityConnection LeadOpptyDataExRelationEntityEdge LeadOpptyDataExRelationFilterInput LeadOpptyDataExRelationOrderByInput LeadOpptyDataExRelationRepository LeadOpptyEntity LeadOpptyEntityConnection LeadOpptyEntityEdge LeadOpptyFilterInput LeadOpptyKPIEntity LeadOpptyKPIEntityConnection LeadOpptyKPIEntityEdge LeadOpptyKpiEnum LeadOpptyKpiEnumFilterInput LeadOpptyKPIFilterInput LeadOpptyKPIOrderByInput LeadOpptyKPIRepository LeadOpptyOrderByInput LeadOpptyPipelineProfileInterface LeadOpptyRepository LeadOpptySharingClientRelationEntity LeadOpptySharingClientRelationEntityConnection LeadOpptySharingClientRelationEntityEdge LeadOpptySharingClientRelationFilterInput LeadOpptySharingClientRelationOrderByInput LeadOpptySharingClientRelationRepository LeadOpptySharingSalesUnitRelationEntity LeadOpptySharingSalesUnitRelationEntityConnection LeadOpptySharingSalesUnitRelationEntityEdge LeadOpptySharingSalesUnitRelationFilterInput LeadOpptySharingSalesUnitRelationOrderByInput LeadOpptySharingSalesUnitRelationRepository LeadOpptyStepCheckListRelationEntity LeadOpptyStepCheckListRelationEntityConnection LeadOpptyStepCheckListRelationEntityEdge LeadOpptyStepCheckListRelationFilterInput LeadOpptyStepCheckListRelationOrderByInput LeadOpptyStepCheckListRelationRepository LeadOrderByInput LeadOrderByNestedInput LeadProcessEntity LeadProcessEntityConnection LeadProcessEntityEdge LeadProcessFilterInput LeadProcessOrderByInput LeadProcessOrderByNestedInput LeadProcessRepository LeadProfileInterface LeadRepository LeadRoleTab LeadsAndOpportunitiesNotificationSettings LeadsAndOpportunitiesNotificationSettingsParams LeadStatusEnum LeadStatusEnumFilterInput LeadTypeEntity LeadTypeEntityConnection LeadTypeEntityEdge LeadTypeFilterInput LeadTypeOrderByInput LeadTypeOrderByNestedInput LeadTypeRepository LinkedItemsProperty ListChart ListingViewInterface LookupEntityTypeEnum LookupItemInput LookupPrimaryRelationResolutionEnum LookupProperty LookupPropertyParams LookupSettingsProperty LookupVisualizationType
Shared types: L
Types several repositories use, or none does, with their fields and their descriptions.
LabelFlagEnum enum Priority, Hot, Stalled
Flags that highlight a lead or opportunity; several can be combined.
| Value | Description |
|---|---|
Priority | Marked as a priority. |
Hot | Marked as hot. |
Stalled | Marked as stalled. |
LabelFlagEnumFilterInput input eq: [LabelFlagEnum!], NOT: LabelFlagEnumFilterInput
Conditions on an enumeration field. Several conditions given together must all match.
| Input field | Type | Description |
|---|---|---|
eq | [LabelFlagEnum!] | Matches any of the listed values. |
NOT | LabelFlagEnumFilterInput | Matches values that do not meet this condition. |
LeadDashboardProfile object filter: LeadFilterTab!, role: LeadRoleTab!, leadProcess: [UUID!], view: LeadDashboardProfileView!
Saved lead dashboard: the filter, lead processes and ownership scope of the leads it covers and the graphs it shows.
| Field | Type | Description |
|---|---|---|
filter | LeadFilterTab! | Filter conditions that determine which records the dashboard includes. |
role | LeadRoleTab! | Ownership scope of the records shown, such as own, shared, managing-unit or unassigned items. |
leadProcess | [UUID!] | Identifiers of the lead processes the profile is restricted to. Null includes all lead processes. |
view | LeadDashboardProfileView! | View settings of the dashboard, including which graphs are shown. |
LeadDashboardProfileView object drilldownFields: [ID!]!, graphs: [DashboardGraphLeadNameType]!
View settings of the lead dashboard: the graphs it shows and the fields listed when a graph value is drilled into.
| Field | Type | Description |
|---|---|---|
drilldownFields | [ID!]! | Identifiers of the fields shown as columns when a dashboard graph value is drilled down into. |
graphs | [DashboardGraphLeadNameType]! | Graphs shown on the lead dashboard, each identified by its graph type. |
LeadFilterTab object 6 fields: isEnabled, filterMainBox, filterSiblingBoxes, …
Filter conditions that select which leads a saved profile or dashboard includes, combining conditions on the lead with conditions on related records.
| Field | Type | Description |
|---|---|---|
isEnabled | Boolean! | Whether the filter is applied. When false, the filter conditions are ignored. |
filterMainBox | MainFilterBox! | Primary group of filter conditions evaluated on the main record type. |
filterSiblingBoxes | [FilterBox!]! | Additional groups of filter conditions evaluated on related record types. |
isCustom | Boolean! | True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions. |
operator | FilterGroupOperator! | How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula. |
formula | String | Boolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom. |
LeadOpportunityProfileInterface interface filter: LeadOpportunityFilterTab!, salesPipeline: [ID!], role: OpportunityRoleTab!
Settings shared by the saved profiles that cover leads and opportunities: the filter, the sales pipelines and the ownership scope of the records shown.
| Field | Type | Description |
|---|---|---|
filter | LeadOpportunityFilterTab! | Filter tab restricting which leads and opportunities the profile shows. |
salesPipeline | [ID!] | Identifiers of the sales pipelines the profile is restricted to. Null includes all pipelines. |
role | OpportunityRoleTab! | Ownership scope of the records shown (own, shared, or managing-unit items). |
LeadOpptyAccountRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for LeadOpptyAccountRelation records.
| Field | Type | Description |
|---|---|---|
getById | LeadOpptyAccountRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [LeadOpptyAccountRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [LeadOpptyAccountRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | LeadOpptyAccountRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
LeadOpptyContactGroupRelationOrderByNestedInput input 8 fields: id, isDeleted, modified, …
Sorting by a field of the related LeadOpptyContactGroupRelation record. Set exactly one field in each item.
| Input field | Type | Description |
|---|---|---|
id | OrderByEnum | Unique identifier of entity. |
isDeleted | OrderByEnum | Specifies if the entity is considered deleted. |
modified | OrderByEnum | Last modification time. |
created | OrderByEnum | Creation time. |
color | OrderByEnum | Display color of the contact group on the org chart, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. |
leadOpptyId | OrderByEnum | Id of the lead or opportunity the contact group belongs to. |
name | OrderByEnum | Name of the entity and its default text representation. |
revision | OrderByEnum | Revision when entity was lastly changed. |
LeadOpptyContactGroupRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for LeadOpptyContactGroupRelation records.
| Field | Type | Description |
|---|---|---|
getById | LeadOpptyContactGroupRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [LeadOpptyContactGroupRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [LeadOpptyContactGroupRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | LeadOpptyContactGroupRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
LeadOpptyContactRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for LeadOpptyContactRelation records.
| Field | Type | Description |
|---|---|---|
getById | LeadOpptyContactRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [LeadOpptyContactRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [LeadOpptyContactRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | LeadOpptyContactRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
LeadOpptyContactSalesRoleRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for LeadOpptyContactSalesRoleRelation records.
| Field | Type | Description |
|---|---|---|
getById | LeadOpptyContactSalesRoleRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [LeadOpptyContactSalesRoleRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [LeadOpptyContactSalesRoleRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | LeadOpptyContactSalesRoleRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
LeadOpptyDataExRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for LeadOpptyDataExRelation records.
| Field | Type | Description |
|---|---|---|
getById | LeadOpptyDataExRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [LeadOpptyDataExRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [LeadOpptyDataExRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | LeadOpptyDataExRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
LeadOpptyKPIRepository object 5 fields: getById, getByIds, getAll, …
Read operations for LeadOpptyKPI records.
| Field | Type | Description |
|---|---|---|
getById | LeadOpptyKPIEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [LeadOpptyKPIEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [LeadOpptyKPIEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | LeadOpptyKPIEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
LeadOpptyPipelineProfileInterface interface leadProcess: [UUID!], filter: ProfileFilterBaseInterface!, salesPipeline: [ID!]
Saved profile restricted to selected sales pipelines and lead processes.
| Field | Type | Description |
|---|---|---|
leadProcess | [UUID!] | Identifiers of the lead processes the profile is restricted to. Null includes all lead processes. |
filter | ProfileFilterBaseInterface! | Filter conditions that determine which records the profile includes. |
salesPipeline | [ID!] | Identifiers of the sales pipelines the profile is restricted to. Null includes all pipelines. |
LeadOpptyRepository object 5 fields: getById, getByIds, getAll, …
Read operations for LeadOppty records.
| Field | Type | Description |
|---|---|---|
getById | LeadOpptyEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [LeadOpptyEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [LeadOpptyEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | LeadOpptyEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
LeadOpptySharingClientRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for LeadOpptySharingClientRelation records.
| Field | Type | Description |
|---|---|---|
getById | LeadOpptySharingClientRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [LeadOpptySharingClientRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [LeadOpptySharingClientRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | LeadOpptySharingClientRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
LeadOpptySharingSalesUnitRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for LeadOpptySharingSalesUnitRelation records.
| Field | Type | Description |
|---|---|---|
getById | LeadOpptySharingSalesUnitRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [LeadOpptySharingSalesUnitRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [LeadOpptySharingSalesUnitRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | LeadOpptySharingSalesUnitRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
LeadOpptyStepCheckListRelationRepository object 5 fields: getById, getByIds, getAll, …
Read operations for LeadOpptyStepCheckListRelation records.
| Field | Type | Description |
|---|---|---|
getById | LeadOpptyStepCheckListRelationEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [LeadOpptyStepCheckListRelationEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [LeadOpptyStepCheckListRelationEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | LeadOpptyStepCheckListRelationEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
LeadOrderByNestedInput input 29 fields: id, isDeleted, modified, …
Sorting by a field of the related Lead record. Set exactly one field in each item.
| Input field | Type | Description |
|---|---|---|
id | OrderByEnum | Unique identifier of entity. |
isDeleted | OrderByEnum | Specifies if the entity is considered deleted. |
modified | OrderByEnum | Last modification time. |
created | OrderByEnum | Creation time. |
currencyExchangeRatesListId | OrderByEnum | Id of the currency exchange rate list applied to this lead. |
description | OrderByEnum | Free-form description of the lead. |
isArchived | 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. |
labelFlag | OrderByEnum | User-set colored flag used to highlight the lead in lists and reports. |
leadSourceId | OrderByEnum | Id of the lead source recording how the lead originated (e.g. Website, Referral, Trade Show). |
leadTypeId | OrderByEnum | Id of the lead type that classifies the lead and drives which form, fields and lead process apply. |
name | OrderByEnum | Name of the entity and its default text representation. |
ownerId | OrderByEnum | Id of the lead owner. |
quickAccountEmail | OrderByEnum | Free-text company email captured at lead creation when no Account record has been linked yet. |
quickAccountName | OrderByEnum | Free-text company name captured at lead creation when no Account record has been linked yet. |
quickAccountPhone | OrderByEnum | Free-text company phone captured at lead creation when no Account record has been linked yet. |
quickContactName | OrderByEnum | Free-text contact name captured at lead creation when no Contact record has been linked yet. |
quickEmail | OrderByEnum | Free-text contact email captured at lead creation when no Contact record has been linked yet. |
quickPhone | OrderByEnum | Free-text contact phone captured at lead creation when no Contact record has been linked yet. |
ranking | OrderByEnum | Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead. |
reasonOfCloseDescription | OrderByEnum | Free-form note explaining why the lead was archived (lost). Captured alongside reasonOfClose. |
reasonOfCloseId | OrderByEnum | Id of the reason recorded when the lead is archived (lost), or empty when none was given. |
shareMode | 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. |
stepId | OrderByEnum | Id of the lead process step. |
unitId | OrderByEnum | Id of the sales unit. |
revision | OrderByEnum | Revision when entity was lastly changed. |
status | OrderByEnum | Current status of the lead (Open, Lost, Qualified). Read-only; derived from the archived flag and lifecycle events. |
enrolledEmailSequences | OrderByEnum | Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). |
relatedEntities | CommonEntityRepositoryOrderByEntityRelationField | Sorts records by whether they are related to the listed records. |
withCustom | CommonEntityRepositoryOrderByCustomField | Sorts by a custom field. |
LeadProcessOrderByNestedInput input 7 fields: id, isDeleted, modified, …
Sorting by a field of the related LeadProcess record. Set exactly one field in each item.
| Input field | Type | Description |
|---|---|---|
id | OrderByEnum | Unique identifier of entity. |
isDeleted | OrderByEnum | Specifies if the entity is considered deleted. |
modified | OrderByEnum | Last modification time. |
created | OrderByEnum | Creation time. |
color | OrderByEnum | Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue. |
name | OrderByEnum | Name of the entity and its default text representation. |
revision | OrderByEnum | Revision when entity was lastly changed. |
LeadProcessRepository object 5 fields: getById, getByIds, getAll, …
Read operations for LeadProcess records.
| Field | Type | Description |
|---|---|---|
getById | LeadProcessEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [LeadProcessEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [LeadProcessEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | LeadProcessEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
LeadProfileInterface interface filter: LeadFilterTab!, leadProcess: [UUID!]
Settings shared by the saved lead profiles: the filter and the lead processes the leads belong to.
| Field | Type | Description |
|---|---|---|
filter | LeadFilterTab! | Filter conditions that determine which records the profile includes. |
leadProcess | [UUID!] | Identifiers of the lead processes the profile is restricted to. Null includes all lead processes. |
LeadRepository object 9 fields: getById, getByIds, getAll, …
Read operations for Lead records.
| Field | Type | Description |
|---|---|---|
getById | LeadEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [LeadEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [LeadEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | LeadEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getChangedFieldsSinceRevision | [UUID!]! (2 args) | Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. |
getBySession | LeadEntityConnection (7 args) | Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids. |
getByIdFormatted | JSONString (2 args) | Returns the values of a record's fields formatted for display, keyed by field id. |
autoPrefill | LeadEntity! (3 args) | Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create. |
aiAutoPrefill | LeadAutoPrefill! (1 args) | Returns an unsaved record pre-filled with the values proposed by an AI record suggestion, together with the fields the suggestion filled in. Nothing is saved; the caller can review the values and create or update the record. |
LeadTypeOrderByNestedInput input 10 fields: id, isDeleted, modified, …
Sorting by a field of the related LeadType record. Set exactly one field in each item.
| Input field | Type | Description |
|---|---|---|
id | OrderByEnum | Unique identifier of entity. |
isDeleted | OrderByEnum | Specifies if the entity is considered deleted. |
modified | OrderByEnum | Last modification time. |
created | OrderByEnum | Creation time. |
formLostEnabled | OrderByEnum | True when the lost form is required on archiving leads of this type. |
isReadonly | OrderByEnum | True when the lead type is system-managed and cannot be edited or deleted by users. |
leadProcessId | OrderByEnum | Id of the lead process that leads of this type follow. |
name | OrderByEnum | Name of the entity and its default text representation. |
isPublished | OrderByEnum | True when the entity configuration is published; false while it exists only as an unpublished draft. |
revision | OrderByEnum | Revision when entity was lastly changed. |
LeadTypeRepository object 8 fields: getById, getByIds, getAll, …
Read operations for LeadType records.
| Field | Type | Description |
|---|---|---|
getById | LeadTypeEntity (1 args) | Returns the record with the given id, or null when there is none. Deleted records are returned as well. |
getByIds | [LeadTypeEntity!]! (1 args) | Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. |
getAll | [LeadTypeEntity!]! (5 args) | Returns the records that match the filter, paged with limit and offset. |
getByCriteria | LeadTypeEntityConnection (7 args) | Returns the records that match the filter as a cursor-paginated connection. |
getPublished | [LeadTypeEntity!]! (5 args) | Returns the published records that match the filter, paged with limit and offset. |
getDrafts | [LeadTypeEntity!]! (2 args) | Returns the records that match the filter, with pending unpublished changes applied where a draft exists. |
getDraftById | LeadTypeEntity! (1 args) | Returns the record with the given id, with its pending unpublished changes applied when a draft exists. |
getByLeadProcess | LeadTypeEntity (1 args) | Returns the lead type that uses the given lead process, or null when none does. |
LookupItemInput input id: UUID!, isPrimary: Boolean
Record to link through a lookup field, optionally as the primary one.
| Input field | Type | Description |
|---|---|---|
id | UUID! | Id of the record to link through the lookup field. |
isPrimary | Boolean | When true, the linked record is marked as the primary one; the lookup field must allow a primary relation. |
LookupVisualizationType enum MultiSelection, Card
How a lookup field shows its linked records on a form.
| Value | Description |
|---|---|
MultiSelection | As a multi-selection list (default). |
Card | As record cards. |