GraphQL Types index T
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
TableReportTabsInterface TableReportTotal TagEntity TagEntityConnection TagEntityEdge TagFilterInput TagOrderByInput TagOrderByNestedInput TagRelationEntity TagRelationEntityConnection TagRelationEntityEdge TagRelationFilterInput TagRelationOrderByInput TagRelationRepository TagRepository TagSupportedEntitiesEnum TagSupportedEntitiesEnumFilterInput TagTabDataGridViewOptionsParams TargetCalculationTypeEnum TargetCalculationTypeEnumFilterInput TargetEntity TargetEntityConnection TargetEntityEdge TargetFilterInput TargetOrderByInput TargetOrderByNestedInput TargetProfileInterface TargetRelationEntity TargetRelationEntityConnection TargetRelationEntityEdge TargetRelationFilterInput TargetRelationOrderByInput TargetRelationRepository TargetRepository TargetsAbsolutePeriod TargetsChartGranularityEnum TargetsChartValue TargetsCurrentMetrics TargetsIndicators TargetsIndicatorsParams TargetsMetricEnum TargetsMetricPeriodEnum TargetSourceKind TargetsPeriod TargetsPeriodFragmentTypeEnum TargetsPeriodParams TargetsPeriodTypeEnum TargetsSettings TargetStatusEnum TargetsUserChartData TargetTabInterface TargetTypeEnum TargetTypeEnumFilterInput TaskAutoPrefill TaskEntity TaskEntityConnection TaskEntityEdge TaskFilterInput TaskOrderByInput TaskOrderByNestedInput TaskRecurrenceEntity TaskRecurrenceEntityConnection TaskRecurrenceEntityEdge TaskRecurrenceFilterInput TaskRecurrenceOrderByInput TaskRecurrenceOrderByNestedInput TaskRecurrenceRepository TaskReminderEntity TaskReminderEntityConnection TaskReminderEntityEdge TaskReminderFilterInput TaskReminderOrderByInput TaskReminderOrderByNestedInput TaskReminderRepository TaskRepository TaskSharingClientRelationEntity TaskSharingClientRelationEntityConnection TaskSharingClientRelationEntityEdge TaskSharingClientRelationFilterInput TaskSharingClientRelationOrderByInput TaskSharingClientRelationRepository TaskSharingSalesUnitRelationEntity TaskSharingSalesUnitRelationEntityConnection TaskSharingSalesUnitRelationEntityEdge TaskSharingSalesUnitRelationFilterInput TaskSharingSalesUnitRelationOrderByInput TaskSharingSalesUnitRelationRepository TaskStatusEnum TaskStatusEnumFilterInput TaskTypeEntity TaskTypeEntityConnection TaskTypeEntityEdge TaskTypeFilterInput TaskTypeOrderByInput TaskTypeOrderByNestedInput TaskTypeRepository TemplateStatusInProcess TernaryConfigEnum TernaryConfigEnumFilterInput TextAreaProperty TextMessageConversationEntity TextMessageConversationEntityConnection TextMessageConversationEntityEdge TextMessageConversationFilterInput TextMessageConversationOrderByInput TextMessageConversationOrderByNestedInput TextMessageConversationRelationsEntity TextMessageConversationRelationsEntityConnection TextMessageConversationRelationsEntityEdge TextMessageConversationRelationsFilterInput TextMessageConversationRelationsOrderByInput TextMessageConversationRelationsRepository TextMessageConversationRepository TextMessageEntity TextMessageEntityConnection TextMessageEntityEdge TextMessageFilterInput TextMessageNotificationSettings TextMessageNotificationSettingsParams TextMessageOrderByInput TextMessageOrderByNestedInput TextMessageRepository TextMessageStatusEnum TextMessageStatusEnumFilterInput TimeframeEntity TimeframeEntityConnection TimeframeEntityEdge TimeframeFilterInput TimeframeFilterTab TimeframeOrderByInput TimeframePivotReportProfile TimeframeProfileInterface TimeframeRepository TimeframeTableReportProfile TranslationEntity TranslationEntityConnection TranslationEntityEdge TranslationFilterInput TranslationLabelTypeEnum TranslationLabelTypeEnumFilterInput TranslationOrderByInput TranslationRepository TypeEntity TypeEntityConnection TypeEntityEdge TypeFilterInput TypeOrderByInput TypeRepository
Types several repositories use, or none does, with their fields and their descriptions.
TagRelationRepository object 5 fields: getById, getByIds, getAll, … Read operations for TagRelation records.
Field Type Description getByIdTagRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[TagRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[TagRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaTagRelationEntityConnection (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.
TagRepository object 7 fields: getById, getByIds, getAll, … Read operations for Tag records.
Field Type Description getByIdTagEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[TagEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[TagEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaTagEntityConnection (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. getByEntityType[TagEntity!]! (2 args)Returns the tags available for the given record type. getByCustomCriteriaTagEntityConnection (7 args)Returns a page of tags that can be used on any of the given record types, in addition to the regular filter. Tags not limited to specific types are always included.
TargetRelationRepository object 5 fields: getById, getByIds, getAll, … Read operations for TargetRelation records.
Field Type Description getByIdTargetRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[TargetRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[TargetRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaTargetRelationEntityConnection (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.
TargetRepository object 5 fields: getById, getByIds, getAll, … Read operations for Target records.
Field Type Description getByIdTargetEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[TargetEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[TargetEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaTargetEntityConnection (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.
TaskOrderByNestedInput input 23 fields: id, isDeleted, modified, … Sorting by a field of the related Task record. Set exactly one field in each item.
Input field Type Description idOrderByEnum Unique identifier of entity. isDeletedOrderByEnum Specifies if the entity is considered deleted. modifiedOrderByEnum Last modification time. createdOrderByEnum Creation time. activityTypeIdOrderByEnum Id of the task type. callDurationOrderByEnum Duration of the recorded call. Set automatically when the task is linked to a call log. callIdOrderByEnum Id of the linked call record. callOutcomeIdOrderByEnum Id of the call outcome option recorded for the call (e.g. Reached, Voicemail, No Answer). currencyExchangeRatesListIdOrderByEnum Id of the currency exchange rate list applied to this task. descriptionOrderByEnum Free-form description of what the task entails. dueDateOrderByEnum Date by which the task is expected to be completed. durationOrderByEnum Estimated duration of the task. Stored as a duration value (days/hours/minutes). ownerIdOrderByEnum Id of the task owner. priorityOrderByEnum Priority level of the task: Low, Medium or High. shareModeOrderByEnum Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). startDateOrderByEnum Date when work on the task is scheduled to begin. subjectOrderByEnum Short summary line shown in lists and notifications. unitIdOrderByEnum Id of the sales unit. revisionOrderByEnum Revision when entity was lastly changed. exchangeEntityIdOrderByEnum External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. gapiEntityIdOrderByEnum External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. o365EntityIdOrderByEnum External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. withCustomCommonEntityRepositoryOrderByCustomField Sorts by a custom field.
TaskRecurrenceRepository object 5 fields: getById, getByIds, getAll, … Read operations for TaskRecurrence records.
Field Type Description getByIdTaskRecurrenceEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[TaskRecurrenceEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[TaskRecurrenceEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaTaskRecurrenceEntityConnection (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.
TaskReminderRepository object 5 fields: getById, getByIds, getAll, … Read operations for TaskReminder records.
Field Type Description getByIdTaskReminderEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[TaskReminderEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[TaskReminderEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaTaskReminderEntityConnection (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.
TaskRepository object 10 fields: getById, getByIds, getAll, … Read operations for Task records.
Field Type Description getByIdTaskEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[TaskEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[TaskEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaTaskEntityConnection (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. getBySessionTaskEntityConnection (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. getByIdFormattedJSONString (2 args) Returns the values of a record's fields formatted for display, keyed by field id. autoPrefillTaskEntity! (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. aiAutoPrefillTaskAutoPrefill! (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. autoPrefillFromEmailTaskAutoPrefill! (2 args)Returns a new, unsaved task pre-filled from an email conversation: subject and description from the last sent email of the conversation that the user can read, the records linked to the conversation (including ones the user cannot open) and its attachments as documents. Nothing is saved.
TaskSharingClientRelationRepository object 5 fields: getById, getByIds, getAll, … Read operations for TaskSharingClientRelation records.
Field Type Description getByIdTaskSharingClientRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[TaskSharingClientRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[TaskSharingClientRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaTaskSharingClientRelationEntityConnection (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.
TaskSharingSalesUnitRelationRepository object 5 fields: getById, getByIds, getAll, … Read operations for TaskSharingSalesUnitRelation records.
Field Type Description getByIdTaskSharingSalesUnitRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[TaskSharingSalesUnitRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[TaskSharingSalesUnitRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaTaskSharingSalesUnitRelationEntityConnection (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.
TaskTypeOrderByNestedInput input 9 fields: id, isDeleted, modified, … Sorting by a field of the related TaskType record. Set exactly one field in each item.
Input field Type Description idOrderByEnum Unique identifier of entity. isDeletedOrderByEnum Specifies if the entity is considered deleted. modifiedOrderByEnum Last modification time. createdOrderByEnum Creation time. iconOrderByEnum Icon used to display tasks of this type in the UI. isReadonlyOrderByEnum True when the task type is system-managed and cannot be edited or deleted by users. nameOrderByEnum Name of the entity and its default text representation. isPublishedOrderByEnum True when the entity configuration is published; false while it exists only as an unpublished draft. revisionOrderByEnum Revision when entity was lastly changed.
TaskTypeRepository object 7 fields: getById, getByIds, getAll, … Read operations for TaskType records.
Field Type Description getByIdTaskTypeEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[TaskTypeEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[TaskTypeEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaTaskTypeEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection. getPublished[TaskTypeEntity!]! (5 args)Returns the published records that match the filter, paged with limit and offset. getDrafts[TaskTypeEntity!]! (2 args)Returns the records that match the filter, with pending unpublished changes applied where a draft exists. getDraftByIdTaskTypeEntity! (1 args)Returns the record with the given id, with its pending unpublished changes applied when a draft exists.
TextMessageConversationOrderByNestedInput input 9 fields: id, isDeleted, modified, … Sorting by a field of the related TextMessageConversation record. Set exactly one field in each item.
Input field Type Description idOrderByEnum Unique identifier of entity. isDeletedOrderByEnum Specifies if the entity is considered deleted. modifiedOrderByEnum Last modification time. createdOrderByEnum Creation time. phoneIdOrderByEnum Id of the sender phone. recipientAccountIdOrderByEnum Id of the matched account. recipientContactIdOrderByEnum Id of the matched contact. recipientPhoneNumberOrderByEnum External phone number of the conversation recipient. Cannot be changed once the conversation has started. revisionOrderByEnum Revision when entity was lastly changed.
TextMessageConversationRelationsRepository object 5 fields: getById, getByIds, getAll, … Read operations for TextMessageConversationRelations records.
TextMessageConversationRepository object 7 fields: getById, getByIds, getAll, … Read operations for TextMessageConversation records.
Field Type Description getByIdTextMessageConversationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[TextMessageConversationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[TextMessageConversationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaTextMessageConversationEntityConnection (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. getByPhoneTextMessageConversationEntity (2 args)Returns the current user's text message conversation with the given phone number, or null when there is none. The user must have a personal SMS number; otherwise an error is returned. pollMessages[TextMessageEntity!]! (1 args)Returns the messages of the text message conversation that were added or changed after the given time, so a client can poll for new messages. Returns an empty list when no time is given.
TextMessageEntity object 22 fields: isDeleteProtected, id, isDeleted, … Message sent or received in a text message conversation or in an AI assistant chat.
Field Type Description isDeleteProtectedBoolean! True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. idID! Unique identifier of entity. isDeletedBoolean Specifies if the entity is considered deleted. modifiedDateTime Last modification time. createdDateTime Creation time. chatConversationChatConversationEntity AI assistant chat conversation this message belongs to, when applicable. textMessageConversationTextMessageConversationEntity Conversation this message belongs to. Empty for messages produced by AI chat that do not belong to a thread of customer conversation. chatConversationIdID Id of the AI assistant chat conversation this message belongs to, when applicable. contentString! Body of the message. May be plain text or a JSON payload (e.g. AI assistant examples / suggestions). datetimeSentDateTime Timestamp the message was sent. directionEmailDirectionEnum! Direction of the message (Incoming, Outgoing). messageSidString External message identifier from the SMS provider (e.g. Twilio Message SID). scoreInt Quality score given to the message by the user (e.g. for AI-suggested replies). Used to feed back into the suggestion engine. statusTextMessageStatusEnum Delivery status of the message: Sending, Sent, Seen or Failed for outgoing messages, Received for incoming ones. textMessageConversationIdID Id of the text message conversation this message belongs to, or empty for AI assistant chat messages. revisionInt Revision when entity was lastly changed. attachmentsCloudObjectRelationEntityConnection (8 args)Files attached to the message (e.g. MMS attachments). contentAsHtmlString! HTML-rendered version of the message body, ready for display in chat UIs. dataAiMessageData Structured AI payload of the message (examples or suggestions). Empty for regular text messages. topicPrompts[String!] List of suggested follow-up prompts produced by the AI for this message. Empty when the AI did not produce prompts. instancePermissions[EntityPermsEnum!]! (1 args)Permissions the current user has on this record, out of the requested ones. creditInfoAiCreditInfo AI credits consumed by generating this text message, and whether the generation is still in progress. Empty when no AI credits were tracked for the message.
TextMessageRepository object 5 fields: getById, getByIds, getAll, … Read operations for TextMessage records.
Field Type Description getByIdTextMessageEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[TextMessageEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[TextMessageEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaTextMessageEntityConnection (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.
TimeframeRepository object 5 fields: getById, getByIds, getAll, … Read operations for Timeframe records.
Field Type Description getByIdTimeframeEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[TimeframeEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[TimeframeEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaTimeframeEntityConnection (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.
TranslationRepository object 7 fields: getById, getByIds, getAll, … Read operations for Translation records.
Field Type Description getByIdTranslationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[TranslationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[TranslationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaTranslationEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection. getPublished[TranslationEntity!]! (5 args)Returns the published records that match the filter, paged with limit and offset. getDrafts[TranslationEntity!]! (2 args)Returns the records that match the filter, with pending unpublished changes applied where a draft exists. getDraftByIdTranslationEntity! (1 args)Returns the record with the given id, with its pending unpublished changes applied when a draft exists.
TypeRepository object 5 fields: getById, getByIds, getAll, … Read operations for Type records.
Field Type Description getByIdTypeEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well. getByIds[TypeEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. getAll[TypeEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset. getByCriteriaTypeEntityConnection (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.
