Types: S

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

SalesRoleEntity SalesRoleEntityConnection SalesRoleEntityEdge SalesRoleFilterInput SalesRoleOrderByInput SalesRoleOrderByNestedInput SalesRoleRepository SalesUnitClientRelationEntity SalesUnitClientRelationEntityConnection SalesUnitClientRelationEntityEdge SalesUnitClientRelationFilterInput SalesUnitClientRelationOrderByInput SalesUnitClientRelationRepository SalesUnitEntity SalesUnitEntityConnection SalesUnitEntityEdge SalesUnitFilterInput SalesUnitOrderByInput SalesUnitOrderByNestedInput SalesUnitRepository SankeyData SankeyDataLink SankeyDataNode ScheduledReportEmail ScheduledReportEmailAttachment ScheduledReportEmailAttachmentParams ScheduledReportEmailParams ScheduleInterface ScorecardData ScreensDefaultProfilesParams ScreensDefaultProfilesParamsParams ScreenTypeEnum ScreenTypeEnumFilterInput SendEmailFollowupTaskSettings SendEmailLinkedEntity SendEmailLinkedEntityParams SendEmailRecipient SendEmailRecipientParams SendEmailService SendEmailServiceParams SendTextMessageRecipient SendTextMessageRecipientParams SequenceItemProperty SequenceItemPropertyParams SequenceParticleProperty SequenceParticlePropertyParams SequenceProperty SequencePropertyParams ServiceMappingType SetProductPriceList SetProductPriceListOperation SetReminderAppointmentInput SetReminderAppointmentPayload SetReminderTaskInput SetReminderTaskPayload SetScheduleReportInput SetScheduleReportPayload SetTaskStatusInput SetTaskStatusPayload ShareModeEnum ShareModeEnumFilterInput ShareModeParamsEnum ShareModeParamsEnumFilterInput SharingRecord SharingRoleEnum SharingRoleEnumFilterInput SiblingBoxInterface SiblingBoxRelationType SiblingRelationType SignedUrl SimulatedTargetIndicators SimulatedTargetIndicatorsParams Size SnapshotIndexedDataInterface SolutionActivityLogConnection SolutionActivityLogEdge SolutionActivityLogEntity SolutionDirectCandidate SolutionEdge SolutionEdgeType SolutionEntity SolutionEntityConnection SolutionEntityEdge SolutionEntityFieldRef SolutionEntityNode SolutionFilterInput SolutionGroup SolutionIndirectCandidate SolutionNodeInterface SolutionNodeOrigin SolutionNodeStats SolutionNodeStatus SolutionNodeStatusResult SolutionOrderByInput SolutionOrderByNestedInput SolutionRecordNode SolutionRecordNodeType SolutionRepository SolutionScanResult SolutionSchema SolutionSchemaJSONString SolutionStats SolutionStatsPeriodEnum SolutionStatusEnum SolutionTabDataGridViewOptionsParams SolutionTemplateEdge SolutionTemplateEntity SolutionTemplateEntityConnection SolutionTemplateEntityEdge SolutionTemplateFilterInput SolutionTemplateGroup SolutionTemplateNodeInterface SolutionTemplateOrderByInput SolutionTemplateOrderByNestedInput SolutionTemplateRepository SolutionTemplateSchema SortField SortOrder StatusInProcessOutput Step StepChecklistActivityItem StepChecklistDocumentFormatEnum StepChecklistDocumentFormatEnumFilterInput StepChecklistEntity StepChecklistEntityConnection StepChecklistEntityEdge StepChecklistError StepChecklistFilterInput StepChecklistOrderByInput StepChecklistOrderByNestedInput StepChecklistRepository StepChecklistSalesRoleRelationEntity StepChecklistSalesRoleRelationEntityConnection StepChecklistSalesRoleRelationEntityEdge StepChecklistSalesRoleRelationFilterInput StepChecklistSalesRoleRelationOrderByInput StepChecklistSalesRoleRelationRepository StepChecklistTypeEnum StepChecklistTypeEnumFilterInput StepChecklistValidationEnum StepChecklistValidationEnumFilterInput StepChecklistVisibilityEnum StepChecklistVisibilityEnumFilterInput StepChecklistVisibilityFilter StepChecklistVisibilityFilterJSONString StepEntity StepEntityConnection StepEntityEdge StepFieldsContainer StepFilterInput StepOrderByInput StepOrderByNestedInput StepRepository String SummaryField SupportUser

Shared types: S

Types several repositories use, or none does, with their fields and their descriptions.

SalesRoleOrderByNestedInput input 7 fields: id, isDeleted, modified, …

Sorting by a field of the related SalesRole 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.
`colorCode`	OrderByEnum	Display color of the sales role, encoded as a 24-bit RGB integer: (red << 16) \| (green << 8) \| blue.
`name`	OrderByEnum	Name of the entity and its default text representation.
`revision`	OrderByEnum	Revision when entity was lastly changed.

SalesRoleRepository object 5 fields: getById, getByIds, getAll, …

Read operations for SalesRole records.

Field	Type	Description
`getById`	SalesRoleEntity (1 args)	Returns the record with the given id, or null when there is none. Deleted records are returned as well.
`getByIds`	[SalesRoleEntity!]! (1 args)	Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
`getAll`	[SalesRoleEntity!]! (5 args)	Returns the records that match the filter, paged with limit and offset.
`getByCriteria`	SalesRoleEntityConnection (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.

SalesUnitClientRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for SalesUnitClientRelation records.

Field	Type	Description
`getById`	SalesUnitClientRelationEntity (1 args)	Returns the record with the given id, or null when there is none. Deleted records are returned as well.
`getByIds`	[SalesUnitClientRelationEntity!]! (1 args)	Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
`getAll`	[SalesUnitClientRelationEntity!]! (5 args)	Returns the records that match the filter, paged with limit and offset.
`getByCriteria`	SalesUnitClientRelationEntityConnection (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.

SalesUnitOrderByNestedInput input 7 fields: id, isDeleted, modified, …

Sorting by a field of the related SalesUnit 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.
`name`	OrderByEnum	Name of the entity and its default text representation.
`parentId`	OrderByEnum	Id of the parent unit, or empty for the root unit.
`revision`	OrderByEnum	Revision when entity was lastly changed.

SalesUnitRepository object 6 fields: getById, getByIds, getAll, …

Read operations for SalesUnit records.

Field	Type	Description
`getById`	SalesUnitEntity (1 args)	Returns the record with the given id, or null when there is none. Deleted records are returned as well.
`getByIds`	[SalesUnitEntity!]! (1 args)	Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
`getAll`	[SalesUnitEntity!]! (5 args)	Returns the records that match the filter, paged with limit and offset.
`getByCriteria`	SalesUnitEntityConnection (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.
`getRoot`	SalesUnitEntity!	Returns the top-level sales unit of the space, the root of the sales unit hierarchy.

SankeyData object 7 fields: startField, endField, startValue, …

Computed data of a Sankey chart: the groups of records at the start and end of the flow and the flows between them.

Field	Type	Description
`startField`	FieldDescriptor	Field the records are grouped by at the start of the flow.
`endField`	FieldDescriptor	Field the records are grouped by at the end of the flow.
`startValue`	Float!	Total aggregated value at the start of the flow.
`endValue`	Float!	Total aggregated value at the end of the flow.
`startNodes`	[SankeyDataNode!]!	Groups at the start of the flow.
`endNodes`	[SankeyDataNode!]!	Groups at the end of the flow.
`links`	[SankeyDataLink!]!	Flows from a start group to an end group, with their values.

SankeyDataLink object 6 fields: startId, startLabel, endId, …

Flow of records from a start group to an end group of a Sankey chart, with its value at both ends.

Field	Type	Description
`startId`	String!	Id of the start node the flow leaves.
`startLabel`	String	Always null; the label is on the startNodes item with the same id.
`endId`	String!	Id of the end node the flow reaches.
`endLabel`	String	Always null; the label is on the endNodes item with the same id.
`endValue`	Float!	Aggregated value of the records in the flow, measured at the end of the flow.
`startValue`	Float!	Aggregated value of the records in the flow, measured at the start of the flow.

SankeyDataNode object id: String!, label: String

Group of records at the start or end of a Sankey chart.

Field	Type	Description
`id`	String!	Id of the node, referenced by the links.
`label`	String	Name of the group the node stands for; null for records without a value.

ScorecardData object value: Float, comparisonValue: Float, comparisonPeriod: PeriodOption

Computed value of a scorecard chart, with the value of the comparison period when one is set.

Field	Type	Description
`value`	Float	Aggregated value shown on the scorecard.
`comparisonValue`	Float	Value of the comparison period; null when the chart has no comparison.
`comparisonPeriod`	PeriodOption	Period the comparison value covers; null when the chart has no comparison.

ShareModeEnum enum Standard, Private, AllView, AllEdit

Who besides the owner can see and edit a record.

Value	Description
`Standard`	Visible according to user roles and sales units, plus the users and units listed in sharingClients and sharingUnits.
`Private`	Visible only to the owner.
`AllView`	All users can view the record.
`AllEdit`	All users can view and edit the record.

ShareModeEnumFilterInput input eq: [ShareModeEnum!], NOT: ShareModeEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input field	Type	Description
`eq`	[ShareModeEnum!]	Matches any of the listed values.
`NOT`	ShareModeEnumFilterInput	Matches values that do not meet this condition.

ShareModeParamsEnum enum ShareToUnitManagers, ShareToIncludedUsers

Legacy additional sharing options of reports and forecasts; kept with the record but no longer applied.

Value	Description
`ShareToUnitManagers`	Legacy option to share with the managers of the selected sales units; no longer applied.
`ShareToIncludedUsers`	Legacy option to share with the included users; no longer applied.

ShareModeParamsEnumFilterInput input eq: [ShareModeParamsEnum!], NOT: ShareModeParamsEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input field	Type	Description
`eq`	[ShareModeParamsEnum!]	Matches any of the listed values.
`NOT`	ShareModeParamsEnumFilterInput	Matches values that do not meet this condition.

SharingRoleEnum enum Watcher, Editor

Access a sharing entry gives the user or sales unit on the shared record.

Value	Description
`Watcher`	Can view the record.
`Editor`	Can view and edit the record.

SharingRoleEnumFilterInput input eq: [SharingRoleEnum!], NOT: SharingRoleEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input field	Type	Description
`eq`	[SharingRoleEnum!]	Matches any of the listed values.
`NOT`	SharingRoleEnumFilterInput	Matches values that do not meet this condition.

SignedUrl object url: String!, signedUrl: String!

Temporary signed download link for a file URL.

Field	Type	Description
`url`	String!	The requested URL that was signed.
`signedUrl`	String!	Signed link that downloads the file without further authentication until it expires.

SolutionEdgeType enum Manual, TriggerImplicit, TriggerExplicit, UsedIn, Reference

Kind of connection an edge represents. Manual edges are drawn by the user; the other types are derived from the records' configuration by the scan.

Value	Description
`Manual`	Drawn by the user.
`TriggerImplicit`	The source changes records in a way that fires the target process's record trigger.
`TriggerExplicit`	A process or email sequence is explicitly configured to start the target process or enroll into the target sequence.
`UsedIn`	A field, sales process, template, report or form link of the source is used in the target's configuration.
`Reference`	A dashboard and a navigator share the same dashboard surface.

SolutionRepository object 8 fields: getById, getByIds, getAll, …

Read operations for Solution records.

Field	Type	Description
`getById`	SolutionEntity (1 args)	Returns the record with the given id, or null when there is none. Deleted records are returned as well.
`getByIds`	[SolutionEntity!]! (1 args)	Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
`getAll`	[SolutionEntity!]! (5 args)	Returns the records that match the filter, paged with limit and offset.
`getByCriteria`	SolutionEntityConnection (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.
`getBySolutionCriteria`	SolutionEntityConnection (7 args)	Returns a page of solutions filtered by owner, status and tags, in addition to the regular filter.
`nodeStatus`	[SolutionNodeStatusResult!]! (2 args)	Returns the current status and name of the given nodes of a solution canvas, computed from the live state of the records and features they reference. Node ids not present on the canvas are left out of the result.
`scan`	SolutionScanResult! (4 args)	Scans a solution canvas for related records and returns an updated canvas together with related records it did not add, so the user can choose which to add. Nothing is saved; save the returned canvas with the update mutation.

SolutionSchemaJSONString scalar scalar

JSON object, sent as a string, conforming to the SolutionSchema type.

SolutionTemplateRepository object 5 fields: getById, getByIds, getAll, …

Read operations for SolutionTemplate records.

Field	Type	Description
`getById`	SolutionTemplateEntity (1 args)	Returns the record with the given id, or null when there is none. Deleted records are returned as well.
`getByIds`	[SolutionTemplateEntity!]! (1 args)	Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
`getAll`	[SolutionTemplateEntity!]! (5 args)	Returns the records that match the filter, paged with limit and offset.
`getByCriteria`	SolutionTemplateEntityConnection (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.

SortOrder enum Asc, Desc

Direction in which a list is sorted.

Value	Description
`Asc`	Ascending order.
`Desc`	Descending order.

Step object id: String!, containers: [FormContainer]

Fields a step section of a form shows for one step of the lead process or pipeline.

Field	Type	Description
`id`	String!	Unique id of the step.
`containers`	[FormContainer]	Field containers shown on this step.

StepChecklistActivityItem object 8 fields: stepChecklistId, stepChecklistRelationId, activityId, …

Completion state of one step checklist item for a lead, opportunity or quote.

Field	Type	Description
`stepChecklistId`	ID!	Id of the step checklist item.
`stepChecklistRelationId`	ID	Id of the record's entry for this checklist item, which holds its checked state and the linked activity, note, email or file; null for items evaluated from field values, processes, email sequences or sales roles.
`activityId`	ID	Id of the task or appointment linked to the item; null when none.
`noteId`	ID	Id of the note linked to the item; null when none.
`emailId`	ID	Id of the email linked to the item; null when none.
`cloudObjectId`	ID	Id of the document linked to the item; null when none.
`itemChecked`	Boolean!	True when the item was checked off on the record.
`isComplete`	Boolean!	True when the item is fulfilled for the record: checked off, or its activity, field value, email, document or process requirement is met.

StepChecklistOrderByNestedInput input 22 fields: id, isDeleted, modified, …

Sorting by a field of the related StepChecklist 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.
`activityTypeId`	OrderByEnum	Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based.
`cloudObjectFormat`	OrderByEnum	File format of the document generated from cloudObjectTemplate when itemType is UseDocumentTemplate: the template's own format or PDF.
`cloudObjectTemplateId`	OrderByEnum	Id of the document template the checklist item fills and attaches to the record. Set when itemType is UseDocumentTemplate.
`description`	OrderByEnum	Free-text description shown alongside the checklist item.
`emailSequenceId`	OrderByEnum	Id of the email sequence the record must be enrolled in to complete the item. Set when itemType is EnrollToEmailSequence.
`fieldId`	OrderByEnum	Id of the related field.
`itemType`	OrderByEnum	Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activityTypeId or running process.
`itemValidation`	OrderByEnum	Condition the item must meet before the record can move past the step; empty when the item is optional. RelatedActivityCompleted is allowed only when itemType is ActivityType.
`label`	OrderByEnum	Display label of the checklist item.
`labelUseLang`	OrderByEnum	When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown.
`processId`	OrderByEnum	Id of the related process.
`sendEmailFieldId`	OrderByEnum	Id of the recipient field.
`sendEmailLookupFieldId`	OrderByEnum	Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary Account.
`sendEmailTemplateId`	OrderByEnum	Id of the email template the email is pre-filled with when the item is completed by sending an email. Set when itemType is SendEmail; empty when no template is preset.
`sortOrder`	OrderByEnum	Position of the checklist item within its step; lower values appear first.
`stepId`	OrderByEnum	Id of the pipeline or process step this checklist item belongs to.
`visibilityType`	OrderByEnum	Whether the item is always shown on the record or only when the record matches visibilityCondition.
`revision`	OrderByEnum	Revision when entity was lastly changed.

StepChecklistRepository object 6 fields: getById, getByIds, getAll, …

Read operations for StepChecklist records.

Field	Type	Description
`getById`	StepChecklistEntity (1 args)	Returns the record with the given id, or null when there is none. Deleted records are returned as well.
`getByIds`	[StepChecklistEntity!]! (1 args)	Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
`getAll`	[StepChecklistEntity!]! (5 args)	Returns the records that match the filter, paged with limit and offset.
`getByCriteria`	StepChecklistEntityConnection (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.
`getByStep`	[StepChecklistEntity!]! (1 args)	Returns the checklist items of the step in their display order.

StepChecklistSalesRoleRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for StepChecklistSalesRoleRelation records.

Field	Type	Description
`getById`	StepChecklistSalesRoleRelationEntity (1 args)	Returns the record with the given id, or null when there is none. Deleted records are returned as well.
`getByIds`	[StepChecklistSalesRoleRelationEntity!]! (1 args)	Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
`getAll`	[StepChecklistSalesRoleRelationEntity!]! (5 args)	Returns the records that match the filter, paged with limit and offset.
`getByCriteria`	StepChecklistSalesRoleRelationEntityConnection (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.

StepChecklistVisibilityFilterJSONString scalar scalar

JSON object, sent as a string, conforming to the StepChecklistVisibilityFilter type.

StepFieldsContainer object 6 fields: id, onMobile, kind, …

Section of a lead or opportunity form that shows different fields for each step of its lead process or pipeline.

Field	Type	Description
`id`	UUID!	Unique id of the form layout item.
`onMobile`	Boolean	When true, this item is shown in the mobile app.
`kind`	FormItemKindEnum!	Kind of layout item — separator, subsection, container, hardcoded container or step container.
`label`	String!	Display name of the multi-step section.
`useLang`	Boolean	When true, the section name uses the workspace's translated language strings.
`steps`	[Step]	Ordered steps of the multi-step form, each with its own field containers.

StepOrderByNestedInput input 15 fields: id, isDeleted, modified, …

Sorting by a field of the related Step 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.
`description`	OrderByEnum	Free-text description shown in the step UI.
`hasReadonlyForm`	OrderByEnum	When true, the record form is read-only while a record is in this step.
`hasVersionIncrement`	OrderByEnum	When true, transitioning a record into this step bumps its version counter.
`leadProcessId`	OrderByEnum	Id of the lead process this step belongs to, or empty when the step is not part of a lead process.
`name`	OrderByEnum	Name of the entity and its default text representation.
`percent`	OrderByEnum	Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps.
`pipelineId`	OrderByEnum	Id of the opportunity pipeline.
`quoteProcessId`	OrderByEnum	Id of the quote process this step belongs to, or empty when the step is not part of a quote process.
`sortOrder`	OrderByEnum	Position of the step within its pipeline or process; lower values appear first.
`timeframe`	OrderByEnum	Expected number of days a record should spend in this step. Used to flag overdue records.
`revision`	OrderByEnum	Revision when entity was lastly changed.

StepRepository object 8 fields: getById, getByIds, getAll, …

Read operations for Step records.

Field	Type	Description
`getById`	StepEntity (1 args)	Returns the record with the given id, or null when there is none. Deleted records are returned as well.
`getByIds`	[StepEntity!]! (1 args)	Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
`getAll`	[StepEntity!]! (5 args)	Returns the records that match the filter, paged with limit and offset.
`getByCriteria`	StepEntityConnection (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.
`getByPipeline`	[StepEntity!]! (1 args)	Returns the steps of the pipeline in their display order.
`getByLeadProcess`	[StepEntity!]! (1 args)	Returns the steps of the lead process in their display order.
`getByQuoteProcess`	[StepEntity!]! (1 args)	Returns the steps of the quote process in their display order.

String scalar scalar

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.