Developers
ChangelogSupportcoevera.comGet API keys
Set your API contextPick a region and space ID once. Every sample fills in your base URL.
Where do I find these?

In Coevera: open your space's API application and choose Show Access. It shows the space ID and the base URL, whose host starts with your region.

From the API: if you know the space ID, the discovery endpoint GET /api/discovery/spaces/{space_id} returns its region and base URLs, without credentials.

Only the region and space ID are kept, in this browser. Never paste a key or password here.

More in the quickstart

GraphQLTypes indexC

Types: C

View as Markdown/reference/graphql/types/c.mdOpen in ClaudeAsk Claude about this pageOpen in ChatGPTAsk ChatGPT about this page

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

CalculatedField CallEntity CallEntityConnection CallEntityEdge CallFilterInput CallOrderByInput CallOrderByNestedInput CallRepository ChangeLabelFlagLeadInput ChangeLabelFlagLeadPayload ChangeLabelFlagOpportunityInput ChangeLabelFlagOpportunityPayload ChangeLeadProcessInput ChangeLeadProcessPayload ChangeLogAccountClassValue ChangeLogAttendeeEmailsValue ChangeLogBooleanValue ChangeLogDatetimeValue ChangeLogDateValue ChangeLogDropdownValue ChangeLogEntityListValue ChangeLogEntityListValueItem ChangeLogFloatValue ChangeLogForeignCurrencyValue ChangeLogGenderValue ChangeLogGeoLocationValue ChangeLogIntValue ChangeLogLabelFlagValue ChangeLogLeadStatusValue ChangeLogMeetingValue ChangeLogMultiCheckboxValue ChangeLogOpptyStatusValue ChangeLogPriorityValue ChangeLogQuoteStatusValue ChangeLogShareModeValue ChangeLogStringValue ChangeLogTagsValue ChangeLogTagsValueItem ChangeLogTaskStatusValue ChangeLogUuidValue ChangeLogValueObject ChangeOwnershipAccountInput ChangeOwnershipAccountPayload ChangeOwnershipAppointmentInput ChangeOwnershipAppointmentPayload ChangeOwnershipContactInput ChangeOwnershipContactPayload ChangeOwnershipCustomEntityInput ChangeOwnershipCustomEntityPayload ChangeOwnershipLeadInput ChangeOwnershipLeadPayload ChangeOwnershipOpportunityInput ChangeOwnershipOpportunityPayload ChangeOwnershipProjectInput ChangeOwnershipProjectPayload ChangeOwnershipQuoteInput ChangeOwnershipQuotePayload ChangeOwnershipReportInput ChangeOwnershipReportPayload ChangeOwnershipTaskInput ChangeOwnershipTaskPayload ChangePipelineOpportunityInput ChangePipelineOpportunityPayload ChangePipelineQuoteInput ChangePipelineQuotePayload ChangeQuoteProcessInput ChangeQuoteProcessPayload ChartComparison ChartYearComparison ChatConversationEntity ChatConversationEntityConnection ChatConversationEntityEdge ChatConversationFilterInput ChatConversationOrderByInput ChatConversationOrderByNestedInput ChatConversationRepository ChatConversationTypeEnum ChatConversationTypeEnumFilterInput ClientEntity ClientEntityConnection ClientEntityEdge ClientExcludedOpptyEntity ClientExcludedOpptyEntityConnection ClientExcludedOpptyEntityEdge ClientExcludedOpptyFilterInput ClientExcludedOpptyOrderByInput ClientExcludedOpptyRepository ClientFavoriteEntity ClientFavoriteEntityConnection ClientFavoriteEntityEdge ClientFavoriteFilterInput ClientFavoriteOrderByInput ClientFavoriteRepository ClientFilterInput ClientOrderByInput ClientOrderByNestedInput ClientRepository ClientSettingEntity ClientSettingEntityConnection ClientSettingEntityEdge ClientSettingFilterInput ClientSettingOrderByInput ClientSettingRepository ClientStoryReadEntity ClientStoryReadEntityConnection ClientStoryReadEntityEdge ClientStoryReadFilterInput ClientStoryReadOrderByInput ClientStoryReadRepository ClientTypeEnum ClientTypeEnumFilterInput ClosingDateProperty CloudObjectDimensions CloudObjectEntity CloudObjectEntityConnection CloudObjectEntityEdge CloudObjectFilterInput CloudObjectFolderEntity CloudObjectFolderEntityConnection CloudObjectFolderEntityEdge CloudObjectFolderFilterInput CloudObjectFolderOrderByInput CloudObjectFolderOrderByNestedInput CloudObjectFolderRepository CloudObjectFolderType CloudObjectMakePublicInput CloudObjectMakePublicPayload CloudObjectOrderByInput CloudObjectOrderByNestedInput CloudObjectRelationEntity CloudObjectRelationEntityConnection CloudObjectRelationEntityEdge CloudObjectRelationFilterInput CloudObjectRelationOrderByInput CloudObjectRelationRepository CloudObjectRepository CloudObjectStepRelationEntity CloudObjectStepRelationEntityConnection CloudObjectStepRelationEntityEdge CloudObjectStepRelationFilterInput CloudObjectStepRelationOrderByInput CloudObjectStepRelationRepository CloudObjectTemplateEntity CloudObjectTemplateEntityConnection CloudObjectTemplateEntityEdge CloudObjectTemplateFilterInput CloudObjectTemplateOrderByInput CloudObjectTemplateOrderByNestedInput CloudObjectTemplateRepository CloudObjectTemplateStatusEnum CloudObjectTemplateStatusEnumFilterInput CloudObjectTypeEnum CloudObjectTypeEnumFilterInput ColumnAlignment ColumnFormatting ColumnFormattingFieldFilterRule ColumnFormattingFilterFieldRuleInterface ColumnPrintOverflow CommonEntityRepositoryOrderByCustomField CommonEntityRepositoryOrderByEntityRelationField CompactViewDrilldownModel CompanyEmailEntity CompanyEmailEntityConnection CompanyEmailEntityEdge CompanyEmailFilterInput CompanyEmailOrderByInput CompanyEmailOrderByNestedInput CompanyEmailRepository CompleteProjectInput CompleteTasksProjectInput ContactAccountAccountRoleRelationEntity ContactAccountAccountRoleRelationEntityConnection ContactAccountAccountRoleRelationEntityEdge ContactAccountAccountRoleRelationFilterInput ContactAccountAccountRoleRelationOrderByInput ContactAccountAccountRoleRelationRepository ContactAccountCardProperty ContactAccountRelationEntity ContactAccountRelationEntityConnection ContactAccountRelationEntityEdge ContactAccountRelationFilterInput ContactAccountRelationOrderByInput ContactAccountRelationOrderByNestedInput ContactAccountRelationRepository ContactAutoPrefill ContactCardProperty ContactDashboardProfile ContactDashboardProfileTab ContactDashboardProfileView ContactDataExRelationEntity ContactDataExRelationEntityConnection ContactDataExRelationEntityEdge ContactDataExRelationFilterInput ContactDataExRelationOrderByInput ContactDataExRelationRepository ContactEntity ContactEntityConnection ContactEntityEdge ContactFilterInput ContactFilterTab ContactKPIEntity ContactKPIEntityConnection ContactKPIEntityEdge ContactKpiEnum ContactKpiEnumFilterInput ContactKPIFilterInput ContactKPIOrderByInput ContactKPIRepository ContactOrderByInput ContactOrderByNestedInput ContactPivotReportProfile ContactProfileInterface ContactRelationEntity ContactRelationFilterInput ContactRelationLabelEntity ContactRelationLabelFilterInput ContactRelationLabelOrderByInput ContactRelationLabelRepository ContactRelationOrderByInput ContactRelationOrderByNestedInput ContactRelationRepository ContactRelationTypeEntity ContactRelationTypeFilterInput ContactRelationTypeOrderByInput ContactRelationTypeOrderByNestedInput ContactRelationTypeRepository ContactRepository ContactRoleTab ContactSharingClientRelationEntity ContactSharingClientRelationEntityConnection ContactSharingClientRelationEntityEdge ContactSharingClientRelationFilterInput ContactSharingClientRelationOrderByInput ContactSharingClientRelationRepository ContactSharingSalesUnitRelationEntity ContactSharingSalesUnitRelationEntityConnection ContactSharingSalesUnitRelationEntityEdge ContactSharingSalesUnitRelationFilterInput ContactSharingSalesUnitRelationOrderByInput ContactSharingSalesUnitRelationRepository ContactSocialRelationEntity ContactSocialRelationEntityConnection ContactSocialRelationEntityEdge ContactSocialRelationFilterInput ContactSocialRelationOrderByInput ContactSocialRelationOrderByNestedInput ContactSocialRelationRepository ContactTableReportProfile ContactTypeEntity ContactTypeEntityConnection ContactTypeEntityEdge ContactTypeFilterInput ContactTypeOrderByInput ContactTypeOrderByNestedInput ContactTypeRepository ContentShareModeConfigEnum ContentShareModeConfigEnumFilterInput ContentShareModeEnum ContentShareModeEnumFilterInput ConvertAccountPayload ConvertAppointmentPayload ConvertContactPayload ConvertedCurrencyField ConvertLeadPayload ConvertOpportunityPayload ConvertProjectPayload ConvertQuotePayload ConvertTaskPayload CopyAccountInput CopyAccountPayload CopyApiAccessInput CopyApiAccessPayload CopyContactInput CopyContactPayload CopyCustomEntityInput CopyCustomEntityPayload CopyLeadInput CopyLeadPayload CopyNoteInput CopyNotePayload CopyProjectObjectiveInput CopyProjectObjectivePayload CopyTargetInput CopyTargetPayload CountryCrmEntity CountryCrmEntityConnection CountryCrmEntityEdge CountryCrmFilterInput CountryCrmOrderByInput CountryCrmRepository CountryProperty CreateAccountInput CreateAccountKPIInput CreateAccountKPIPayload CreateAccountPayload CreateAccountProductPricingInput CreateAccountProductPricingPayload CreateAccountRelationInput CreateAccountRelationLabelInput CreateAccountRelationLabelPayload CreateAccountRelationPayload CreateAccountRelationTypeInput CreateAccountRelationTypePayload CreateAccountRoleInput CreateAccountRolePayload CreateAccountSharingClientRelationInput CreateAccountSharingClientRelationNoAccountBackrefInput CreateAccountSharingClientRelationPayload CreateAccountSharingSalesUnitRelationInput CreateAccountSharingSalesUnitRelationNoAccountBackrefInput CreateAccountSharingSalesUnitRelationPayload CreateAccountSocialRelationInput CreateAccountSocialRelationNoIdBackrefInput CreateAccountSocialRelationPayload CreateActivityCommentInput CreateActivityCommentNoActivityBackrefInput CreateActivityCommentPayload CreateActivityKPIInput CreateActivityKPIPayload CreateActivityRelationInput CreateActivityRelationNoActivityBackrefInput CreateActivityRelationPayload CreateAllowedAccountTypeInput CreateAllowedAccountTypeNoMasterRightBackrefInput CreateAllowedAccountTypePayload CreateAllowedAppointmentTypeInput CreateAllowedAppointmentTypeNoMasterRightBackrefInput CreateAllowedAppointmentTypePayload CreateAllowedCompanyEmailInput CreateAllowedCompanyEmailNoMasterRightBackrefInput CreateAllowedCompanyEmailPayload CreateAllowedCompanyPhoneInput CreateAllowedCompanyPhoneNoMasterRightBackrefInput CreateAllowedCompanyPhonePayload CreateAllowedContactTypeInput CreateAllowedContactTypeNoMasterRightBackrefInput CreateAllowedContactTypePayload CreateAllowedLeadTypeInput CreateAllowedLeadTypeNoMasterRightBackrefInput CreateAllowedLeadTypePayload CreateAllowedPipelineInput CreateAllowedPipelineNoMasterRightBackrefInput CreateAllowedPipelinePayload CreateAllowedQuoteTypeInput CreateAllowedQuoteTypeNoMasterRightBackrefInput CreateAllowedQuoteTypePayload CreateAllowedTaskTypeInput CreateAllowedTaskTypeNoMasterRightBackrefInput CreateAllowedTaskTypePayload CreateAppointmentClientInviteesRelationInput CreateAppointmentClientInviteesRelationNoAppointmentBackrefInput CreateAppointmentClientInviteesRelationPayload CreateAppointmentContactInviteesRelationInput CreateAppointmentContactInviteesRelationNoAppointmentBackrefInput CreateAppointmentContactInviteesRelationPayload CreateAppointmentInput CreateAppointmentPayload CreateAppointmentReminderInput CreateAppointmentReminderNoAppointmentBackrefInput CreateAppointmentReminderPayload CreateAppointmentScheduleInput CreateAppointmentSchedulePayload CreateApprovalApproverInput CreateApprovalApproverNoApprovalBackrefInput CreateApprovalApproverPayload CreateApprovalInput CreateApprovalPayload CreateApprovalProcessActivityLogLineInput CreateApprovalProcessActivityLogLinePayload CreateApprovalProcessInput CreateApprovalProcessPayload CreateCallInput CreateCallPayload CreateChatConversationInput CreateChatConversationPayload CreateClientExcludedOpptyInput CreateClientExcludedOpptyPayload CreateClientFavoriteInput CreateClientFavoriteNoOwnerBackrefInput CreateClientFavoritePayload CreateClientInput CreateClientPayload CreateClientStoryReadInput CreateClientStoryReadPayload CreateCloudObjectFolderInput CreateCloudObjectFolderPayload CreateCloudObjectInput CreateCloudObjectPayload CreateCloudObjectRelationInput CreateCloudObjectRelationNoBackrefInput CreateCloudObjectRelationPayload CreateCloudObjectStepRelationNoStepBackrefInput CreateCloudObjectTemplateInput CreateCloudObjectTemplatePayload CreateContactAccountAccountRoleRelationInput CreateContactAccountAccountRoleRelationNoContactAccountRelationBackrefInput CreateContactAccountAccountRoleRelationPayload CreateContactAccountRelationInput CreateContactAccountRelationNoContactBackrefInput CreateContactAccountRelationPayload CreateContactInput CreateContactKPIInput CreateContactKPIPayload CreateContactPayload CreateContactRelationInput CreateContactRelationLabelInput CreateContactRelationLabelPayload CreateContactRelationPayload CreateContactRelationTypeInput CreateContactRelationTypePayload CreateContactSharingClientRelationInput CreateContactSharingClientRelationNoContactBackrefInput CreateContactSharingClientRelationPayload CreateContactSharingSalesUnitRelationInput CreateContactSharingSalesUnitRelationNoContactBackrefInput CreateContactSharingSalesUnitRelationPayload CreateContactSocialRelationInput CreateContactSocialRelationNoIdBackrefInput CreateContactSocialRelationPayload CreateCountryCrmInput CreateCountryCrmPayload CreateCurrencyExchangeRateInput CreateCurrencyExchangeRateNoCurrencyBackrefInput CreateCurrencyExchangeRateNoCurrencyExchangeRateListBackrefInput CreateCurrencyExchangeRatePayload CreateCurrencyExchangeRatesListInput CreateCurrencyExchangeRatesListPayload CreateCurrencyInput CreateCurrencyPayload CreateCustomEntityDataExRelationInput CreateCustomEntityDataExRelationPayload CreateCustomEntitySharingClientRelationInput CreateCustomEntitySharingClientRelationNoCustomEntityBackrefInput CreateCustomEntitySharingClientRelationPayload CreateCustomEntitySharingSalesUnitRelationInput CreateCustomEntitySharingSalesUnitRelationNoCustomEntityBackrefInput CreateCustomEntitySharingSalesUnitRelationPayload CreateDataInput CreateDataPayload CreateDraftFieldInput CreateDraftTranslationInput CreateEmailContentSharingClientRelationInput CreateEmailContentSharingClientRelationNoEmailBackrefInput CreateEmailContentSharingClientRelationPayload CreateEmailContentSharingSalesUnitRelationInput CreateEmailContentSharingSalesUnitRelationNoEmailBackrefInput CreateEmailContentSharingSalesUnitRelationPayload CreateEmailEventInput CreateEmailEventPayload CreateEmailInput CreateEmailLabelInput CreateEmailLabelPayload CreateEmailLabelRelationInput CreateEmailLabelRelationPayload CreateEmailPayload CreateEmailSequenceActivityLogInput CreateEmailSequenceActivityLogLineInput CreateEmailSequenceActivityLogLinePayload CreateEmailSequenceActivityLogPayload CreateEmailSequenceEnrolledInput CreateEmailSequenceEnrolledPayload CreateEmailSequenceInput CreateEmailSequencePayload CreateEmailTemplateFolderInput CreateEmailTemplateFolderPayload CreateEmailTemplateInput CreateEmailTemplatePayload CreateEmailTemplateSharingClientRelationInput CreateEmailTemplateSharingClientRelationNoEmailTemplateBackrefInput CreateEmailTemplateSharingClientRelationPayload CreateEmailTemplateSharingSalesUnitRelationInput CreateEmailTemplateSharingSalesUnitRelationNoEmailTemplateBackrefInput CreateEmailTemplateSharingSalesUnitRelationPayload CreateEmailThreadMailboxClientReadStateInput CreateEmailThreadMailboxClientReadStatePayload CreateEntityFitnessIndicatorInput CreateEntityFitnessIndicatorPayload CreateEntityScoringInput CreateEntityScoringPayload CreateFieldMappingInput CreateFieldMappingPayload CreateFieldPayload CreateForecastInput CreateForecastPayload CreateFormViewInput CreateFormViewPayload CreateFormViewSharingClientRelationInput CreateFormViewSharingClientRelationNoFormViewBackrefInput CreateFormViewSharingClientRelationPayload CreateFormViewSharingSalesUnitRelationInput CreateFormViewSharingSalesUnitRelationNoFormViewBackrefInput CreateFormViewSharingSalesUnitRelationPayload CreateGhostContactAccountAccountRoleRelationInput CreateGhostContactAccountAccountRoleRelationNoGhostContactAccountRelationBackrefInput CreateGhostContactAccountAccountRoleRelationPayload CreateGhostContactAccountRelationInput CreateGhostContactAccountRelationPayload CreateGhostContactInput CreateGhostContactPayload CreateGhostLeadOpptyContactRelationInput CreateGhostLeadOpptyContactRelationPayload CreateGhostLeadOpptyContactSalesRoleRelationInput CreateGhostLeadOpptyContactSalesRoleRelationNoGhostLeadOpptyContactRelationBackrefInput CreateGhostLeadOpptyContactSalesRoleRelationPayload CreateImageCloudObjectPayload CreateImageInput CreateImportMappingMaskInput CreateImportMappingMaskPayload CreateLeadInput CreateLeadOpptyAccountRelationInput CreateLeadOpptyAccountRelationNoLeadOpptyBackrefInput CreateLeadOpptyAccountRelationPayload CreateLeadOpptyContactGroupRelationInput CreateLeadOpptyContactGroupRelationPayload CreateLeadOpptyContactRelationInput CreateLeadOpptyContactRelationNoLeadOpptyBackrefInput CreateLeadOpptyContactRelationPayload CreateLeadOpptyContactSalesRoleRelationInput CreateLeadOpptyContactSalesRoleRelationNoLeadOpptyContactRelationBackrefInput CreateLeadOpptyContactSalesRoleRelationPayload CreateLeadOpptyKPIInput CreateLeadOpptyKPIPayload CreateLeadOpptySharingClientRelationInput CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput CreateLeadOpptySharingClientRelationPayload CreateLeadOpptySharingSalesUnitRelationInput CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput CreateLeadOpptySharingSalesUnitRelationPayload CreateLeadOpptyStepCheckListRelationInput CreateLeadOpptyStepCheckListRelationPayload CreateLeadPayload CreateLeadProcessInput CreateLeadProcessPayload CreateMasterRightInput CreateMasterRightPayload CreateMemoCommentInput CreateMemoCommentNoMemoBackrefInput CreateMemoCommentPayload CreateMemoInput CreateMemoPayload CreateMessageRelationInput CreateMessageRelationNoMessageBackrefInput CreateMessageRelationPayload CreateMessageSharingClientRelationInput CreateMessageSharingClientRelationNoMessageBackrefInput CreateMessageSharingClientRelationPayload CreateMessageSharingSalesUnitRelationInput CreateMessageSharingSalesUnitRelationNoMessageBackrefInput CreateMessageSharingSalesUnitRelationPayload CreateNoteInput CreateNotePayload CreateOnlineFormActivityLogLineInput CreateOnlineFormActivityLogLinePayload CreateOnlineFormDataExRelationInput CreateOnlineFormDataExRelationPayload CreateOnlineFormInput CreateOnlineFormPayload CreateOnlineFormRelationInput CreateOnlineFormRelationNoOnlineFormBackrefInput CreateOnlineFormRelationPayload CreateOnlineFormStyleInput CreateOnlineFormStylePayload CreateOnlineFormTypeEmailRelationInput CreateOnlineFormTypeEmailRelationPayload CreateOnlineFormTypeInput CreateOnlineFormTypePayload CreateOpportunityInput CreateOpportunityPayload CreateOpptyProductRelationDataExRelationInput CreateOpptyProductRelationDataExRelationPayload CreateOpptyProductRelationInput CreateOpptyProductRelationNoBackrefInput CreateOpptyProductRelationPayload CreateOpptyProductRelationRevenueScheduleNoIdBackrefInput CreateOpptyRecurrenceInput CreateOpptyRecurrenceNoOpptyBackrefInput CreateOpptyRecurrencePayload CreateOpptyRevenueScheduleNoIdBackrefInput CreateOrUpdateAccountInput CreateOrUpdateAccountKPIInput CreateOrUpdateAccountProductPricingInput CreateOrUpdateAccountRelationInput CreateOrUpdateAccountRelationLabelInput CreateOrUpdateAccountRelationTypeInput CreateOrUpdateAccountRoleInput CreateOrUpdateAccountSharingClientRelationInput CreateOrUpdateAccountSharingSalesUnitRelationInput CreateOrUpdateAccountSocialRelationInput CreateOrUpdateActivityCommentInput CreateOrUpdateActivityKPIInput CreateOrUpdateActivityRelationInput CreateOrUpdateAllowedAccountTypeInput CreateOrUpdateAllowedAppointmentTypeInput CreateOrUpdateAllowedCompanyEmailInput CreateOrUpdateAllowedCompanyPhoneInput CreateOrUpdateAllowedContactTypeInput CreateOrUpdateAllowedLeadTypeInput CreateOrUpdateAllowedPipelineInput CreateOrUpdateAllowedQuoteTypeInput CreateOrUpdateAllowedTaskTypeInput CreateOrUpdateAppointmentClientInviteesRelationInput CreateOrUpdateAppointmentContactInviteesRelationInput CreateOrUpdateAppointmentInput CreateOrUpdateAppointmentReminderInput CreateOrUpdateAppointmentScheduleInput CreateOrUpdateApprovalApproverInput CreateOrUpdateApprovalInput CreateOrUpdateApprovalProcessActivityLogLineInput CreateOrUpdateApprovalProcessInput CreateOrUpdateCallInput CreateOrUpdateChatConversationInput CreateOrUpdateClientExcludedOpptyInput CreateOrUpdateClientFavoriteInput CreateOrUpdateClientInput CreateOrUpdateClientStoryReadInput CreateOrUpdateCloudObjectFolderInput CreateOrUpdateCloudObjectInput CreateOrUpdateCloudObjectRelationInput CreateOrUpdateCloudObjectStepRelationInput CreateOrUpdateCloudObjectStepRelationNoStepBackrefInput CreateOrUpdateCloudObjectTemplateInput CreateOrUpdateContactAccountAccountRoleRelationInput CreateOrUpdateContactAccountRelationInput CreateOrUpdateContactInput CreateOrUpdateContactKPIInput CreateOrUpdateContactRelationInput CreateOrUpdateContactRelationLabelInput CreateOrUpdateContactRelationTypeInput CreateOrUpdateContactSharingClientRelationInput CreateOrUpdateContactSharingSalesUnitRelationInput CreateOrUpdateContactSocialRelationInput CreateOrUpdateCountryCrmInput CreateOrUpdateCurrencyExchangeRateInput CreateOrUpdateCurrencyExchangeRatesListInput CreateOrUpdateCurrencyInput CreateOrUpdateCustomEntityDataExRelationInput CreateOrUpdateCustomEntitySharingClientRelationInput CreateOrUpdateCustomEntitySharingSalesUnitRelationInput CreateOrUpdateEmailContentSharingClientRelationInput CreateOrUpdateEmailContentSharingSalesUnitRelationInput CreateOrUpdateEmailEventInput CreateOrUpdateEmailInput CreateOrUpdateEmailLabelInput CreateOrUpdateEmailLabelRelationInput CreateOrUpdateEmailSequenceActivityLogInput CreateOrUpdateEmailSequenceActivityLogLineInput CreateOrUpdateEmailSequenceEnrolledInput CreateOrUpdateEmailSequenceInput CreateOrUpdateEmailTemplateFolderInput CreateOrUpdateEmailTemplateInput CreateOrUpdateEmailTemplateSharingClientRelationInput CreateOrUpdateEmailTemplateSharingSalesUnitRelationInput CreateOrUpdateEmailThreadMailboxClientReadStateInput CreateOrUpdateEntityFitnessIndicatorInput CreateOrUpdateEntityFitnessIndicatorNoEntityFitnessBackrefInput CreateOrUpdateEntityScoringInput CreateOrUpdateFieldMappingInput CreateOrUpdateForecastInput CreateOrUpdateFormViewInput CreateOrUpdateFormViewSharingClientRelationInput CreateOrUpdateFormViewSharingSalesUnitRelationInput CreateOrUpdateGhostContactAccountAccountRoleRelationInput CreateOrUpdateGhostContactAccountRelationInput CreateOrUpdateGhostContactInput CreateOrUpdateGhostLeadOpptyContactRelationInput CreateOrUpdateGhostLeadOpptyContactSalesRoleRelationInput CreateOrUpdateImportMappingMaskInput CreateOrUpdateLeadInput CreateOrUpdateLeadOpptyAccountRelationInput CreateOrUpdateLeadOpptyContactGroupRelationInput CreateOrUpdateLeadOpptyContactRelationInput CreateOrUpdateLeadOpptyContactSalesRoleRelationInput CreateOrUpdateLeadOpptyKPIInput CreateOrUpdateLeadOpptySharingClientRelationInput CreateOrUpdateLeadOpptySharingSalesUnitRelationInput CreateOrUpdateLeadOpptyStepCheckListRelationInput CreateOrUpdateLeadProcessInput CreateOrUpdateMasterRightInput CreateOrUpdateMediaInput CreateOrUpdateMemoCommentInput CreateOrUpdateMemoInput CreateOrUpdateMessageRelationInput CreateOrUpdateMessageSharingClientRelationInput CreateOrUpdateMessageSharingSalesUnitRelationInput CreateOrUpdateNoteInput CreateOrUpdateOnlineFormActivityLogLineInput CreateOrUpdateOnlineFormDataExRelationInput CreateOrUpdateOnlineFormInput CreateOrUpdateOnlineFormRelationInput CreateOrUpdateOnlineFormStyleInput CreateOrUpdateOnlineFormTypeEmailRelationInput CreateOrUpdateOnlineFormTypeInput CreateOrUpdateOpportunityInput CreateOrUpdateOpptyProductRelationDataExRelationInput CreateOrUpdateOpptyProductRelationInput CreateOrUpdateOpptyProductRelationNoBackrefInput CreateOrUpdateOpptyRecurrenceInput CreateOrUpdateParentAccountRelationTypeInput CreateOrUpdatePhoneInput CreateOrUpdatePipelineInput CreateOrUpdateProcessActivityLogInput CreateOrUpdateProcessActivityLogLineInput CreateOrUpdateProcessInput CreateOrUpdateProcessTemplateInput CreateOrUpdateProductCategoryInput CreateOrUpdateProductInput CreateOrUpdateProductPipelineRelationInput CreateOrUpdateProductPriceListInput CreateOrUpdateProductPriceListPriceInput CreateOrUpdateProfileRelationInput CreateOrUpdateProjectContactRelationInput CreateOrUpdateProjectInput CreateOrUpdateProjectKPIInput CreateOrUpdateProjectObjectiveInput CreateOrUpdateProjectSharingClientRelationInput CreateOrUpdateProjectSharingSalesUnitRelationInput CreateOrUpdateQuoteAccountRelationInput CreateOrUpdateQuoteContactRelationInput CreateOrUpdateQuoteDataExRelationInput CreateOrUpdateQuoteInput CreateOrUpdateQuoteKPIInput CreateOrUpdateQuoteProcessInput CreateOrUpdateQuoteSharingClientRelationInput CreateOrUpdateQuoteSharingSalesUnitRelationInput CreateOrUpdateReportScheduleInput CreateOrUpdateSalesRoleInput CreateOrUpdateSalesUnitInput CreateOrUpdateSolutionInput CreateOrUpdateSolutionTemplateInput CreateOrUpdateStepChecklistInput CreateOrUpdateStepChecklistNoStepBackrefInput CreateOrUpdateStepChecklistSalesRoleRelationInput CreateOrUpdateStepInput CreateOrUpdateStepNoLeadProcessBackrefInput CreateOrUpdateStepNoPipelineBackrefInput CreateOrUpdateStepNoQuoteProcessBackrefInput CreateOrUpdateTagInput CreateOrUpdateTagRelationInput CreateOrUpdateTargetInput CreateOrUpdateTargetRelationInput CreateOrUpdateTaskInput CreateOrUpdateTaskRecurrenceInput CreateOrUpdateTaskReminderInput CreateOrUpdateTaskSharingClientRelationInput CreateOrUpdateTaskSharingSalesUnitRelationInput CreateOrUpdateTextMessageConversationRelationsInput CreateOrUpdateTextMessageNoChatConversationBackrefInput CreateOrUpdateTextMessageNoTextMessageConversationBackrefInput CreateOrUpdateUnsubscribedPhoneInput CreateOrUpdateWebhookEventInput CreateOrUpdateWebhookInput CreateParentAccountRelationTypeInput CreateParentAccountRelationTypePayload CreatePhoneInput CreatePhonePayload CreatePipelineInput CreatePipelinePayload CreateProcessActivityLogInput CreateProcessActivityLogLineInput CreateProcessActivityLogLinePayload CreateProcessActivityLogPayload CreateProcessFromTemplateInput CreateProcessFromTemplatePayload CreateProcessInput CreateProcessPayload CreateProcessTemplateInput CreateProcessTemplatePayload CreateProductCategoryInput CreateProductCategoryPayload CreateProductInput CreateProductNoProductCategoryBackrefInput CreateProductPayload CreateProductPipelineRelationInput CreateProductPipelineRelationNoProductBackrefInput CreateProductPipelineRelationPayload CreateProductPriceListInput CreateProductPriceListPayload CreateProductPriceListPriceInput CreateProductPriceListPriceNoProductPriceListBackrefInput CreateProductPriceListPricePayload CreateProfileRelationInput CreateProfileRelationNoAccountBackrefInput CreateProfileRelationNoContactBackrefInput CreateProfileRelationNoLeadOpptyBackrefInput CreateProfileRelationNoProjectBackrefInput CreateProfileRelationNoQuoteBackrefInput CreateProfileRelationPayload CreateProjectContactRelationInput CreateProjectContactRelationNoProjectBackrefInput CreateProjectContactRelationPayload CreateProjectInput CreateProjectKPIInput CreateProjectKPIPayload CreateProjectObjectiveInput CreateProjectObjectivePayload CreateProjectPayload CreateProjectSharingClientRelationInput CreateProjectSharingClientRelationNoProjectBackrefInput CreateProjectSharingClientRelationPayload CreateProjectSharingSalesUnitRelationInput CreateProjectSharingSalesUnitRelationNoProjectBackrefInput CreateProjectSharingSalesUnitRelationPayload CreateQuoteAccountRelationInput CreateQuoteAccountRelationNoQuoteBackrefInput CreateQuoteAccountRelationPayload CreateQuoteContactRelationInput CreateQuoteContactRelationNoQuoteBackrefInput CreateQuoteContactRelationPayload CreateQuoteDataExRelationInput CreateQuoteDataExRelationPayload CreateQuoteInput CreateQuoteKPIInput CreateQuoteKPIPayload CreateQuoteNoOpptyBackrefInput CreateQuotePayload CreateQuoteProcessInput CreateQuoteProcessPayload CreateQuoteSharingClientRelationInput CreateQuoteSharingClientRelationNoQuoteBackrefInput CreateQuoteSharingClientRelationPayload CreateQuoteSharingSalesUnitRelationInput CreateQuoteSharingSalesUnitRelationNoQuoteBackrefInput CreateQuoteSharingSalesUnitRelationPayload CreateReportScheduleInput CreateReportSchedulePayload CreateSalesRoleInput CreateSalesRolePayload CreateSalesUnitClientRelationNoClientBackrefInput CreateSalesUnitInput CreateSalesUnitPayload CreateSolutionInput CreateSolutionPayload CreateSolutionTemplateInput CreateSolutionTemplatePayload CreateStepChecklistInput CreateStepChecklistNoStepBackrefInput CreateStepChecklistPayload CreateStepChecklistSalesRoleRelationInput CreateStepChecklistSalesRoleRelationNoStepChecklistBackrefInput CreateStepChecklistSalesRoleRelationPayload CreateStepInput CreateStepNoLeadProcessBackrefInput CreateStepNoPipelineBackrefInput CreateStepNoQuoteProcessBackrefInput CreateStepPayload CreateTagInput CreateTagPayload CreateTagRelationInput CreateTagRelationNoAccountBackrefInput CreateTagRelationNoAppointmentBackrefInput CreateTagRelationNoContactBackrefInput CreateTagRelationNoEmailBackrefInput CreateTagRelationNoLeadBackrefInput CreateTagRelationNoOpptyBackrefInput CreateTagRelationNoProcessBackrefInput CreateTagRelationNoProjectBackrefInput CreateTagRelationNoQuoteBackrefInput CreateTagRelationNoSolutionBackrefInput CreateTagRelationNoTaskBackrefInput CreateTagRelationPayload CreateTargetInput CreateTargetPayload CreateTargetRelationInput CreateTargetRelationNoGroupTargetBackrefInput CreateTargetRelationPayload CreateTaskInput CreateTaskPayload CreateTaskRecurrenceInput CreateTaskRecurrenceNoTaskBackrefInput CreateTaskRecurrencePayload CreateTaskReminderInput CreateTaskReminderNoTaskBackrefInput CreateTaskReminderPayload CreateTaskSharingClientRelationInput CreateTaskSharingClientRelationNoTaskBackrefInput CreateTaskSharingClientRelationPayload CreateTaskSharingSalesUnitRelationInput CreateTaskSharingSalesUnitRelationNoTaskBackrefInput CreateTaskSharingSalesUnitRelationPayload CreateTextMessageConversationInput CreateTextMessageConversationPayload CreateTextMessageConversationRelationsInput CreateTextMessageConversationRelationsNoTextMessageConversationBackrefInput CreateTextMessageConversationRelationsPayload CreateTextMessageInput CreateTextMessageNoChatConversationBackrefInput CreateTextMessageNoTextMessageConversationBackrefInput CreateTextMessagePayload CreateTranslationPayload CreateUnsubscribedPhoneInput CreateUnsubscribedPhonePayload CreateWebhookEventInput CreateWebhookEventPayload CreateWebhookInput CreateWebhookPayload CsvDelimiter CsvOptions CsvOptionsParams CsvQuotechar CurrencyEntity CurrencyEntityConnection CurrencyEntityEdge CurrencyExchangeRateEntity CurrencyExchangeRateEntityConnection CurrencyExchangeRateEntityEdge CurrencyExchangeRateFilterInput CurrencyExchangeRateOrderByInput CurrencyExchangeRateRepository CurrencyExchangeRatesListEntity CurrencyExchangeRatesListEntityConnection CurrencyExchangeRatesListEntityEdge CurrencyExchangeRatesListFilterInput CurrencyExchangeRatesListOrderByInput CurrencyExchangeRatesListOrderByNestedInput CurrencyExchangeRatesListRepository CurrencyFilterInput CurrencyForeignField CurrencyForeignFieldInput CurrencyForeignProperty CurrencyOrderByInput CurrencyOrderByNestedInput CurrencyProperty CurrencyRepository CustomEntitiesNotificationSetting CustomEntitiesNotificationSettingParams CustomEntityApiAccessPermission CustomEntityDataExRelationEntity CustomEntityDataExRelationEntityConnection CustomEntityDataExRelationEntityEdge CustomEntityDataExRelationFilterInput CustomEntityDataExRelationOrderByInput CustomEntityDataExRelationRepository CustomEntityEntity CustomEntityEntityConnection CustomEntityEntityEdge CustomEntityFilterInput CustomEntityFilterTab CustomEntityID CustomEntityIDParams CustomEntityMasterRight CustomEntityMasterRightParams CustomEntityOrderByInput CustomEntityOrderByNestedInput CustomEntityPivotReportProfile CustomEntityProfileInterface CustomEntityRelationDataEntity CustomEntityRelationDataEntityConnection CustomEntityRelationDataEntityEdge CustomEntityRelationDataFilterInput CustomEntityRelationDataOrderByInput CustomEntityRelationDataRepository CustomEntityRelationEntity CustomEntityRelationEntityConnection CustomEntityRelationEntityEdge CustomEntityRelationFilterInput CustomEntityRelationOrderByInput CustomEntityRelationOrderByNestedInput CustomEntityRelationRepository CustomEntityRepository CustomEntityRoleTab CustomEntitySharingClientRelationEntity CustomEntitySharingClientRelationEntityConnection CustomEntitySharingClientRelationEntityEdge CustomEntitySharingClientRelationFilterInput CustomEntitySharingClientRelationOrderByInput CustomEntitySharingClientRelationRepository CustomEntitySharingSalesUnitRelationEntity CustomEntitySharingSalesUnitRelationEntityConnection CustomEntitySharingSalesUnitRelationEntityEdge CustomEntitySharingSalesUnitRelationFilterInput CustomEntitySharingSalesUnitRelationOrderByInput CustomEntitySharingSalesUnitRelationRepository CustomEntityTableReportProfile CustomEntityTypeEntity CustomEntityTypeEntityConnection CustomEntityTypeEntityEdge CustomEntityTypeFilterInput CustomEntityTypeOrderByInput CustomEntityTypeOrderByNestedInput CustomEntityTypeRepository CustomField CustomRecaptcha

Shared types: C

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

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

Sorting by a field of the related Call record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
accountIdOrderByEnumId of the linked account.
callerIdOrderByEnumId of the calling user.
clientIdOrderByEnumId of the user the call was made with.
contactIdOrderByEnumId of the linked contact.
leadOpptyIdOrderByEnumId of the linked lead or opportunity, or empty when not linked.
opptyProductRelationIdOrderByEnumId of the linked opportunity product line-item.
phoneNumberOrderByEnumExternal phone number called or received, in E.164 format.
productIdOrderByEnumId of the linked product.
transcriptionIdOrderByEnumExternal transcription identifier from the calling provider.
transcriptionLanguageOrderByEnumLanguage requested for the transcription as a BCP-47 locale tag (e.g. "en-US").
transcriptionSummaryOrderByEnumAI-generated summary of the call transcription.
CallRepository object 6 fields: getById, getByIds, getAll, …

Read operations for Call records.

FieldTypeDescription
getByIdCallEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CallEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CallEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaCallEntityConnection (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.
getBySidCallEntity (1 args)Returns the call with the given call SID assigned by the telephony provider. An error is returned when no such call exists.
ChatConversationRepository object 6 fields: getById, getByIds, getAll, …

Read operations for ChatConversation records.

FieldTypeDescription
getByIdChatConversationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ChatConversationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ChatConversationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaChatConversationEntityConnection (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.
pollMessages[TextMessageEntity!]! (1 args)Returns the messages of the AI chat conversation that were added or changed after the given time, so a client can poll for new replies.
ClientExcludedOpptyRepository object 6 fields: getById, getByIds, getAll, …

Read operations for ClientExcludedOppty records.

FieldTypeDescription
getByIdClientExcludedOpptyEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ClientExcludedOpptyEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ClientExcludedOpptyEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaClientExcludedOpptyEntityConnection (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.
isOpptyExcludedBoolean! (2 args)Returns true when the user has excluded the opportunity from their forecast and quota calculations.
ClientFavoriteRepository object 6 fields: getById, getByIds, getAll, …

Read operations for ClientFavorite records.

FieldTypeDescription
getByIdClientFavoriteEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ClientFavoriteEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ClientFavoriteEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaClientFavoriteEntityConnection (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.
isEntityFavoriteBoolean! (8 args)Returns true when the record is marked as a favorite by the user. Exactly one record id must be given.
ClientOrderByNestedInput input 18 fields: id, isDeleted, modified, …

Sorting by a field of the related Client record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
defaultUnitIdOrderByEnumId of the default sales unit.
emailOrderByEnumEmail. Readonly information from UserProfile.
firstNameOrderByEnumFirst name. Readonly information from UserProfile.
lastActiveOrderByEnumTimestamp of the user's most recent login or API request.
lastNameOrderByEnumLast name. Readonly information from UserProfile.
masterRightIdOrderByEnumId of the assigned user role.
middleNameOrderByEnumMiddle name. Readonly information from UserProfile.
phoneOrderByEnumPhone number. Readonly information from UserProfile.
pictureUrlOrderByEnumPicture name. Readonly information from UserProfile.
positionOrderByEnumJob title or position of the user.
regionOrderByEnumRegion. Readonly information from UserProfile.
timezoneOrderByEnumDeprecated time zone offset of the user, copied from the user profile; read-only. Use timezoneName instead.
revisionOrderByEnumRevision when entity was lastly changed.
nameOrderByEnumDisplay name of the user, formatted according to the user's name format preference.
ClientRepository object 13 fields: getById, getByIds, getAll, …

Read operations for Client records.

FieldTypeDescription
getByIdClientEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ClientEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ClientEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaClientEntityConnection (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.
clientEmailsInSubscription[String!]!Returns the email addresses of all users in every space of the subscription the current space belongs to, sorted alphabetically.
getEntitySyncSettingsEntitySyncSettings (1 args)Returns the current user's synchronization setting with the given name, or null when it does not exist.
getEntitySyncSettingStatusEntitySyncSettings (1 args)Returns the space-wide synchronization status entry with the given name, or null when it does not exist. Only names ending with "_status" are resolved.
getContactMappings[EntityMapping!]! (4 args)Returns the current user's links between Coevera contacts and contacts in an external service (Exchange, Office 365 or Google) used by contact synchronization.
getTaskMappings[EntityMapping!]! (4 args)Returns the current user's links between Coevera tasks and tasks in an external service (Exchange, Office 365 or Google) used by task synchronization.
getEventMappings[EntityMapping!]! (4 args)Returns the current user's links between Coevera appointments and events in an external service (Exchange, Office 365 or Google) used by calendar synchronization.
getByEmailClientEntity (1 args)Returns the space user with the given email address, or null when there is none. The address is compared case-insensitively.
getSupportUsers[SupportUser!]! (1 args)Returns the support staff who can be invited to the space: customer support users and users of the subscription's partner.
ClientSettingRepository object 6 fields: getById, getByIds, getAll, …

Read operations for ClientSetting records.

FieldTypeDescription
getByIdClientSettingEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ClientSettingEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ClientSettingEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaClientSettingEntityConnection (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.
getString (1 args)Returns the value of the current user's setting with the given name, or null when the setting does not exist.
ClientStoryReadRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ClientStoryRead records.

FieldTypeDescription
getByIdClientStoryReadEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ClientStoryReadEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ClientStoryReadEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaClientStoryReadEntityConnection (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.
CloudObjectFolderOrderByNestedInput input 10 fields: id, isDeleted, modified, …

Sorting by a field of the related CloudObjectFolder record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
entityApiNameOrderByEnumAPI name of the custom entity the folder is attached to. Set only for folders on custom entity records; otherwise empty.
nameOrderByEnumName of the entity and its default text representation.
onlineFormTypeIdOrderByEnumId of the online form template, or empty when not associated with a form.
parentCloudObjectFolderIdOrderByEnumId of the parent folder, or empty for top-level folders.
revisionOrderByEnumRevision when entity was lastly changed.
typeOrderByEnumFolder kind: Company for shared company folders, Record for folders attached to a specific record.
CloudObjectFolderRepository object 5 fields: getById, getByIds, getAll, …

Read operations for CloudObjectFolder records.

FieldTypeDescription
getByIdCloudObjectFolderEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CloudObjectFolderEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CloudObjectFolderEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaCloudObjectFolderEntityConnection (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.
CloudObjectRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for CloudObjectRelation records.

FieldTypeDescription
getByIdCloudObjectRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CloudObjectRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CloudObjectRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaCloudObjectRelationEntityConnection (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.
CloudObjectRepository object 14 fields: getById, getByIds, getAll, …

Read operations for CloudObject records.

FieldTypeDescription
getByIdCloudObjectEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CloudObjectEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CloudObjectEntity!]! (6 args)Returns the files that match the filter, paged with limit and offset.
getByCriteriaCloudObjectEntityConnection (8 args)Returns the files 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.
getSignedUrls[SignedUrl!]! (2 args)Returns SignedUrl with public downloadable url link and their id.
getDocumentPreviewUrlDocumentPreviewUrl! (1 args)Returns a URL of a PDF preview of an Office document (Word, Excel or PowerPoint file). When the preview cannot be produced, the URL is null and the error explains why.
getBySessionCloudObjectEntityConnection (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.
getByIdsForProcess[CloudObjectEntity!]! (2 args)Returns those of the given files that are attached to the process or to any email template. Ids of other files are ignored.
getByIdsForEmailSequence[CloudObjectEntity!]! (2 args)Returns those of the given files that are attached to the email sequence. Ids of files not attached to it are ignored.
getByIdsForReportSchedule[CloudObjectEntity!]! (2 args)Returns those of the given files that are attached to the report schedule. Ids of files not attached to it are ignored.
getByIdsForApprovalProcess[CloudObjectEntity!]! (2 args)Returns those of the given files that are attached to the approval process. Ids of files not attached to it are ignored.
getByIdsForFieldMapping[CloudObjectEntity!]! (2 args)Returns those of the given files that are attached to the field mapping. Ids of files not attached to it are ignored.
getByIdsForOnlineFormType[CloudObjectEntity!]! (2 args)Returns those of the given files that were uploaded with a submission of the online form. Ids of other files are ignored.
CloudObjectStepRelationRepository object 6 fields: getById, getByIds, getAll, …

Read operations for CloudObjectStepRelation records.

FieldTypeDescription
getByIdCloudObjectStepRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CloudObjectStepRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CloudObjectStepRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaCloudObjectStepRelationEntityConnection (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.
getByStepId[CloudObjectStepRelationEntity!]! (1 args)Returns the files attached to the pipeline step, in their display order.
CloudObjectTemplateRepository object 7 fields: getById, getByIds, getAll, …

Read operations for CloudObjectTemplate records.

FieldTypeDescription
getByIdCloudObjectTemplateEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CloudObjectTemplateEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CloudObjectTemplateEntity!]! (6 args)Returns the files that match the filter, paged with limit and offset.
getByCriteriaCloudObjectTemplateEntityConnection (8 args)Returns the files 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.
getSignedUrls[SignedUrl!]! (2 args)Returns SignedUrl with public downloadable url link and their id.
getDocumentPreviewUrlDocumentPreviewUrl! (1 args)Returns a URL of a PDF preview of an Office document (Word, Excel or PowerPoint file). When the preview cannot be produced, the URL is null and the error explains why.
CloudObjectTypeEnum enum S3FileUpload, S3File, S3Image, GoogleDriveFile, OneDriveFile, BoxFile, … (11 values)

Where a document or image is stored and how its content is obtained.

ValueDescription
S3FileUploadUse on create when url points to a file already uploaded to Coevera storage; the object is then saved as S3File.
S3FileFile stored in Coevera storage; content can be sent directly or is downloaded from url.
S3ImageImage stored in Coevera storage, such as a record picture or product image.
GoogleDriveFileFile linked from Google Drive.
OneDriveFileFile linked from OneDrive.
BoxFileFile linked from Box.
DropboxFileFile linked from Dropbox.
SharepointFileFile linked from SharePoint.
ExternalURLLink to an external web page or resource.
AlfrescoFileFile linked from Alfresco.
UrlFileFile referenced by a direct download URL.
CloudObjectTypeEnumFilterInput input eq: [CloudObjectTypeEnum!], NOT: CloudObjectTypeEnumFilterInput

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

Input fieldTypeDescription
eq[CloudObjectTypeEnum!]Matches any of the listed values.
NOTCloudObjectTypeEnumFilterInputMatches values that do not meet this condition.
ColumnAlignment enum Left, Center, Right

Horizontal alignment of a report column or dashboard section header.

ValueDescription
LeftContent is aligned to the left.
CenterContent is centered.
RightContent is aligned to the right.
CommonEntityRepositoryOrderByCustomField input field: String, way: OrderByEnum

Sorting by a single custom field.

Input fieldTypeDescription
fieldStringApi name of the custom field to sort by.
wayOrderByEnumSort direction.
CommonEntityRepositoryOrderByEntityRelationField input relatedEntities: [EntityFilterRelatedField], way: OrderByEnum

Sorting by relation to a set of other records.

Input fieldTypeDescription
relatedEntities[EntityFilterRelatedField]Records the sorted records may be related to.
wayOrderByEnumSort direction.
CompactViewDrilldownModel object listViewItems: GenericDrilldownDataGridViewItems!

Records behind a chart or related-record list of a record's preview pane, listed as rows with the requested columns.

FieldTypeDescription
listViewItemsGenericDrilldownDataGridViewItems! (9 args)Records of the drilldown, one row per record with the requested columns.
CompanyEmailOrderByNestedInput input 10 fields: id, isDeleted, modified, …

Sorting by a field of the related CompanyEmail record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
emailOrderByEnumEmail address of the company mailbox (the From address).
enabledOrderByEnumFalse when the mailbox is disabled (either by the user or because the underlying feature is not available); true otherwise.
errorCodeOrderByEnumError code recorded for the mailbox; empty when healthy. Set on integration failures or when the user disables the integration.
nameOrderByEnumDisplay name of the company email account, shown in the UI.
pictureUrlOrderByEnumURL of the avatar image used as the sender picture for emails sent from this account.
serviceTypeOrderByEnumEmail service the company email account is connected through and sends from: Microsoft 365, Google or SendGrid.
CompanyEmailRepository object 6 fields: getById, getByIds, getAll, …

Read operations for CompanyEmail records.

FieldTypeDescription
getByIdCompanyEmailEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CompanyEmailEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CompanyEmailEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaCompanyEmailEntityConnection (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.
getAllForAdmin[CompanyEmailEntity!]! (5 args)Returns all company email accounts of the space, including those shared with other users, for administration.
ContactAccountAccountRoleRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ContactAccountAccountRoleRelation records.

FieldTypeDescription
getByIdContactAccountAccountRoleRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ContactAccountAccountRoleRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ContactAccountAccountRoleRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaContactAccountAccountRoleRelationEntityConnection (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.
ContactAccountRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ContactAccountRelation records.

FieldTypeDescription
getByIdContactAccountRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ContactAccountRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ContactAccountRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaContactAccountRelationEntityConnection (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.
ContactDashboardProfile object filter: ContactFilterTab!, role: ContactRoleTab!, view: ContactDashboardProfileView!

Saved contact dashboard: the filter and ownership scope of the contacts it covers and the graphs it shows.

FieldTypeDescription
filterContactFilterTab!Filter conditions that determine which records the dashboard includes.
roleContactRoleTab!Ownership scope of the records shown, such as own, shared or managing-unit items.
viewContactDashboardProfileView!View settings of the dashboard, including which graphs are shown.
ContactDashboardProfileView object drilldownFields: [ID!]!, graphs: [DashboardGraphContactNameType]!

View settings of the contact dashboard: the graphs it shows and the fields listed when a graph value is drilled into.

FieldTypeDescription
drilldownFields[ID!]!Identifiers of the fields shown as columns when a dashboard graph value is drilled down into.
graphs[DashboardGraphContactNameType]!Graphs shown on the contact dashboard, each identified by its graph type.
ContactDataExRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ContactDataExRelation records.

FieldTypeDescription
getByIdContactDataExRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ContactDataExRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ContactDataExRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaContactDataExRelationEntityConnection (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.
ContactKPIRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ContactKPI records.

FieldTypeDescription
getByIdContactKPIEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ContactKPIEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ContactKPIEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaContactKPIEntityConnection (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.
ContactOrderByNestedInput input 40 fields: id, isDeleted, modified, …

Sorting by a field of the related Contact record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
addressOrderByEnumStreet address of the contact.
cityOrderByEnumCity of the contact address.
commentsOrderByEnumFree-form notes describing the contact.
contactTypeIdOrderByEnumId of the contact type assigned to this contact.
countryOrderByEnumCountry of the contact address.
currencyExchangeRatesListIdOrderByEnumId of the currency exchange rate list applied to this contact.
email1OrderByEnumPrimary email address of the contact. Used as default recipient for emails sent from Coevera.
email2OrderByEnumAdditional email address.
email3OrderByEnumAdditional email address.
email4OrderByEnumAdditional email address.
email5OrderByEnumAdditional email address.
firstNameOrderByEnumGiven name of the contact.
genderOrderByEnumGender of the contact: Unknown when not specified, Male, Female or NonBinary.
isArchivedOrderByEnumTrue when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated.
lastNameOrderByEnumFamily name of the contact.
middleNameOrderByEnumMiddle name of the contact, if applicable.
ownerIdOrderByEnumId of the contact owner.
phone1OrderByEnumPrimary phone number of the contact. Used as default target for click-to-call.
phone2OrderByEnumAdditional phone number.
phone3OrderByEnumAdditional phone number.
phone4OrderByEnumAdditional phone number.
phone5OrderByEnumAdditional phone number.
positionOrderByEnumJob title or position of the contact.
quickAccountNameOrderByEnumFree-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account.
shareModeOrderByEnumSharing 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.
stateProvinceOrderByEnumState or province of the contact address.
titleOrderByEnumHonorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name.
unitIdOrderByEnumId of the sales unit.
zipCodeOrderByEnumZIP or postal code of the contact address.
revisionOrderByEnumRevision when entity was lastly changed.
enrolledEmailSequencesOrderByEnumNumber of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted).
exchangeEntityIdOrderByEnumExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
gapiEntityIdOrderByEnumExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
o365EntityIdOrderByEnumExternal identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine.
relatedEntitiesCommonEntityRepositoryOrderByEntityRelationFieldSorts records by whether they are related to the listed records.
withCustomCommonEntityRepositoryOrderByCustomFieldSorts by a custom field.
ContactRelationLabelRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ContactRelationLabel records.

FieldTypeDescription
getByIdContactRelationLabelEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ContactRelationLabelEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ContactRelationLabelEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteria[ContactRelationLabelEntity!]! (3 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.
ContactRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ContactRelation records.

FieldTypeDescription
getByIdContactRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ContactRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ContactRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteria[ContactRelationEntity!]! (3 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.
ContactRelationTypeRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ContactRelationType records.

FieldTypeDescription
getByIdContactRelationTypeEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ContactRelationTypeEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ContactRelationTypeEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteria[ContactRelationTypeEntity!]! (3 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.
ContactRepository object 10 fields: getById, getByIds, getAll, …

Read operations for Contact records.

FieldTypeDescription
getByIdContactEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ContactEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ContactEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaContactEntityConnection (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.
getBySessionContactEntityConnection (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.
getRelatedToAccount[ContactEntity!]! (6 args)Returns the contacts linked to the given account, optionally narrowed by name.
autoPrefillContactEntity! (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.
aiAutoPrefillContactAutoPrefill! (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.
ContactSharingClientRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ContactSharingClientRelation records.

FieldTypeDescription
getByIdContactSharingClientRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ContactSharingClientRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ContactSharingClientRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaContactSharingClientRelationEntityConnection (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.
ContactSharingSalesUnitRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ContactSharingSalesUnitRelation records.

FieldTypeDescription
getByIdContactSharingSalesUnitRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ContactSharingSalesUnitRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ContactSharingSalesUnitRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaContactSharingSalesUnitRelationEntityConnection (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.
ContactSocialRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ContactSocialRelation records.

FieldTypeDescription
getByIdContactSocialRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ContactSocialRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ContactSocialRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaContactSocialRelationEntityConnection (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.
ContactTypeOrderByNestedInput input 8 fields: id, isDeleted, modified, …

Sorting by a field of the related ContactType record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
isReadonlyOrderByEnumTrue when the contact type is system-managed and cannot be edited or deleted by users.
nameOrderByEnumName of the entity and its default text representation.
isPublishedOrderByEnumTrue when the entity configuration is published; false while it exists only as an unpublished draft.
revisionOrderByEnumRevision when entity was lastly changed.
ContactTypeRepository object 7 fields: getById, getByIds, getAll, …

Read operations for ContactType records.

FieldTypeDescription
getByIdContactTypeEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ContactTypeEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ContactTypeEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaContactTypeEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getPublished[ContactTypeEntity!]! (5 args)Returns the published records that match the filter, paged with limit and offset.
getDrafts[ContactTypeEntity!]! (2 args)Returns the records that match the filter, with pending unpublished changes applied where a draft exists.
getDraftByIdContactTypeEntity! (1 args)Returns the record with the given id, with its pending unpublished changes applied when a draft exists.
CountryCrmRepository object 5 fields: getById, getByIds, getAll, …

Read operations for CountryCrm records.

FieldTypeDescription
getByIdCountryCrmEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CountryCrmEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CountryCrmEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaCountryCrmEntityConnection (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.
CreateActivityCommentNoActivityBackrefInput input 5 fields: modified, created, comment, …

Field values of a new ActivityComment record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
commentString!Free-form text body of the comment.
ownerIdID!Id of the comment author.
revisionIntRevision when entity was lastly changed.
CreateActivityRelationNoActivityBackrefInput input 12 fields: modified, created, projectObjective, …

Field values of a new ActivityRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
projectObjectiveCreateProjectObjectiveInputProject objective the activity advances, or empty.
accountIdIDId of the linked account.
contactIdIDId of the linked contact.
customEntityIdIDId of the linked custom entity record.
leadOpptyIdIDId of the lead or opportunity the activity is linked to, or empty when not linked.
projectIdIDId of the linked project.
projectObjectiveIdIDId of the project objective the activity advances, or empty when it is not linked to one.
quoteIdIDId of the linked quote.
sortOrderIntDisplay order of the activity within its project objective. Required only when projectId is set.
revisionIntRevision when entity was lastly changed.
CreateCloudObjectRelationNoBackrefInput input 9 fields: modified, created, cloudObject, …

Field values of a new CloudObjectRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
cloudObjectCreateCloudObjectInputCloud object (file) being linked.
callIdIDId of the linked call.
cloudObjectFolderIdIDId of the folder within the parent record, or empty when stored at the record root.
cloudObjectIdIDId of the linked file.
mediaIdIDId of the linked media record.
onlineFormFieldIdIDId of the online form field the file was uploaded into.
revisionIntRevision when entity was lastly changed.
CreateLeadOpptyAccountRelationNoLeadOpptyBackrefInput input 5 fields: modified, created, accountId, …

Field values of a new LeadOpptyAccountRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
accountIdID!Id of the account linked to the lead or opportunity.
isPrimaryBoolean!True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row.
revisionIntRevision when entity was lastly changed.
CreateLeadOpptyContactRelationNoLeadOpptyBackrefInput input 11 fields: modified, created, leadOpptyContactGroupRelation, …

Field values of a new LeadOpptyContactRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
leadOpptyContactGroupRelationCreateLeadOpptyContactGroupRelationInputContact group on the org chart this contact belongs to, or empty for ungrouped contacts.
commentStringFree-form note describing this contact link.
contactIdID!Id of the contact linked to the lead or opportunity.
isPrimaryBoolean!True for the row that represents the primary related entity for this record. Setting isPrimary to true on a row automatically clears it on any other primary row.
leadOpptyContactGroupRelationIdIDId of the org-chart contact group this contact belongs to, or empty for ungrouped contacts. The group must belong to the same lead or opportunity.
positionInGroupJSONStringOrg-chart layout position of the contact within its group, as a JSON object {"x": <int>, "y": <int>}.
relationshipOrgRelationshipTypeEnumOrg-chart relationship of the contact within the lead/opportunity hierarchy.
revisionIntRevision when entity was lastly changed.
salesRoles[CreateLeadOpptyContactSalesRoleRelationNoLeadOpptyContactRelationBackrefInput!]Sales roles assigned to the contact for this lead or opportunity.
CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput input 5 fields: modified, created, clientId, …

Field values of a new LeadOpptySharingClientRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
clientIdID!Id of the user.
roleSharingRoleEnumAccess the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it.
revisionIntRevision when entity was lastly changed.
CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput input 5 fields: modified, created, role, …

Field values of a new LeadOpptySharingSalesUnitRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
roleSharingRoleEnumAccess the sharing gives the sales unit on the lead or opportunity: Watcher can view it, Editor can view and edit it.
unitIdID!Id of the sales unit.
revisionIntRevision when entity was lastly changed.
CreateMessageRelationNoMessageBackrefInput input 9 fields: modified, created, accountId, …

Field values of a new MessageRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
accountIdIDId of the linked account.
contactIdIDId of the linked contact.
customEntityIdIDId of the linked custom entity record.
leadOpptyIdIDId of the lead or opportunity the message is linked to, or empty when not linked.
projectIdIDId of the linked project.
quoteIdIDId of the linked quote.
revisionIntRevision when entity was lastly changed.
CreateMessageSharingClientRelationNoMessageBackrefInput input modified: DateTime, created: DateTime, clientId: ID!, revision: Int

Field values of a new MessageSharingClientRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
clientIdID!Id of the user.
revisionIntRevision when entity was lastly changed.
CreateMessageSharingSalesUnitRelationNoMessageBackrefInput input modified: DateTime, created: DateTime, unitId: ID!, revision: Int

Field values of a new MessageSharingSalesUnitRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
unitIdID!Id of the sales unit.
revisionIntRevision when entity was lastly changed.
CreateOpptyProductRelationNoBackrefInput input 17 fields: modified, created, pairedOpptyProductRelation, …

Field values of a new OpptyProductRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
pairedOpptyProductRelationCreateOpptyProductRelationInputCounterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing.
amountFloatTotal amount of the line item (price * quantity, with discounts applied).
commentStringFree-form note describing this line item.
currencyExchangeRatesListIdIDId of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote.
onlineFormFieldIdIDId of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission.
opptyProductRelationTypeIdIDId of the line-item type.
pairedOpptyProductRelationIdIDId of the paired line item.
priceFloatPer-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly.
productIdID!Id of the product on this line item. Set on create; cannot be changed afterwards.
quantityFloatNumber of product units on this line item.
sectionIdIDIdentifier of the product section this line belongs to (see the productSections JSON layout on the parent opportunity or quote).
sortOrderIntDisplay order of the line item within its section. Maintained automatically when lines are added or moved.
customFieldsJSONStringCustom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
revisionIntRevision when entity was lastly changed.
revenueScheduleCreateOpptyProductRelationRevenueScheduleNoIdBackrefInputPer-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level.
CreateOrUpdateOpptyProductRelationNoBackrefInput input 18 fields: id, modified, created, …

Field values of an OpptyProductRelation record to create, or to update when its id is set, together with the record it belongs to.

Input fieldTypeDescription
idIDUnique identifier of entity.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
pairedOpptyProductRelationCreateOpptyProductRelationInputCounterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing.
amountFloatTotal amount of the line item (price * quantity, with discounts applied).
commentStringFree-form note describing this line item.
currencyExchangeRatesListIdIDId of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote.
onlineFormFieldIdIDId of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission.
opptyProductRelationTypeIdIDId of the line-item type.
pairedOpptyProductRelationIdIDId of the paired line item.
priceFloatPer-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly.
productIdIDId of the product on this line item. Set on create; cannot be changed afterwards.
quantityFloatNumber of product units on this line item.
sectionIdIDIdentifier of the product section this line belongs to (see the productSections JSON layout on the parent opportunity or quote).
sortOrderIntDisplay order of the line item within its section. Maintained automatically when lines are added or moved.
customFieldsJSONStringCustom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
revisionIntRevision when entity was lastly changed.
revenueScheduleUpdateOpptyProductRelationRevenueScheduleNoIdBackrefInputPer-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level.
CreateProfileRelationNoLeadOpptyBackrefInput input 8 fields: modified, created, accountId, …

Field values of a new ProfileRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
accountIdIDId of the linked account.
contactIdIDId of the linked contact.
customEntityIdIDId of the linked custom entity record.
profileIdID!Id of the screen profile.
projectIdIDId of the linked project.
quoteIdIDId of the linked quote.
CsvDelimiter enum comma, semicolon, tab, colon

Character that separates values in a generated CSV file.

ValueDescription
commaComma (,).
semicolonSemicolon (;).
tabTab character.
colonColon (:).
CsvQuotechar enum quotation, apostrophe

Character used to quote values in a generated CSV file.

ValueDescription
quotationDouble quotation mark (").
apostropheApostrophe (').
CurrencyExchangeRateRepository object 5 fields: getById, getByIds, getAll, …

Read operations for CurrencyExchangeRate records.

FieldTypeDescription
getByIdCurrencyExchangeRateEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CurrencyExchangeRateEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CurrencyExchangeRateEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaCurrencyExchangeRateEntityConnection (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.
CurrencyExchangeRatesListOrderByNestedInput input 6 fields: id, isDeleted, modified, …

Sorting by a field of the related CurrencyExchangeRatesList record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
validFromOrderByEnumDate the exchange rate list becomes effective. The list valid for any given moment is the most recent one whose validFrom is in the past. Time component is truncated to midnight on set.
revisionOrderByEnumRevision when entity was lastly changed.
CurrencyExchangeRatesListRepository object 5 fields: getById, getByIds, getAll, …

Read operations for CurrencyExchangeRatesList records.

FieldTypeDescription
getByIdCurrencyExchangeRatesListEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CurrencyExchangeRatesListEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CurrencyExchangeRatesListEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaCurrencyExchangeRatesListEntityConnection (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.
CurrencyForeignField object 5 fields: baseValue, currencyId, valueForeign, …

Amount in a foreign currency together with its value in the base currency of the space.

FieldTypeDescription
baseValueFloatValue in the base currency of the space. If empty, it is calculated from valueForeign at the current exchange rate.
currencyIdID!Id of the currency of valueForeign.
valueForeignFloatValue in the currency set by currencyId. If empty, it is calculated from baseValue at the current exchange rate.
convertedValueFloatValue converted into the current user's currency. Not filled on records; always null.
convertedValueCurrencyIdUUIDId of the currency of convertedValue. Not filled on records; always null.
CurrencyForeignFieldInput input baseValue: Float, currencyId: ID!, valueForeign: Float

Amount in a foreign currency and its value in the base currency of the space, as set on create or update.

Input fieldTypeDescription
baseValueFloatValue in the base currency of the space. If empty, it is calculated from valueForeign at the current exchange rate.
currencyIdID!Id of the currency of valueForeign.
valueForeignFloatValue in the currency set by currencyId. If empty, it is calculated from baseValue at the current exchange rate.
CurrencyOrderByNestedInput input 8 fields: id, isDeleted, modified, …

Sorting by a field of the related Currency record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
codeOrderByEnumName of the entity and its default text representation.
isBaseOrderByEnumTrue for the space's base currency. There is exactly one base currency per space and it cannot be deleted.
symbolOrderByEnumDisplay symbol of the currency (e.g. "$", "€"). Used when formatting amounts in the UI.
revisionOrderByEnumRevision when entity was lastly changed.
CurrencyRepository object 6 fields: getById, getByIds, getAll, …

Read operations for Currency records.

FieldTypeDescription
getByIdCurrencyEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CurrencyEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CurrencyEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaCurrencyEntityConnection (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.
getBaseCurrencyEntity!Returns the base currency of the space, in which amounts are converted and reported.
CustomEntityDataExRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for CustomEntityDataExRelation records.

FieldTypeDescription
getByIdCustomEntityDataExRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CustomEntityDataExRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CustomEntityDataExRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaCustomEntityDataExRelationEntityConnection (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.
CustomEntityID object entityApiName: String!, id: UUID!

Reference to a custom entity record: the API name of its custom entity and its id.

FieldTypeDescription
entityApiNameString!API name of the custom entity type the referenced record belongs to.
idUUID!Identifier of the referenced custom entity record.
CustomEntityIDParams input entityApiName: String!, id: UUID!

Reference to a custom entity record: the API name of its custom entity and its id.

Input fieldTypeDescription
entityApiNameString!API name of the custom entity type the referenced record belongs to.
idUUID!Identifier of the referenced custom entity record.
CustomEntityOrderByNestedInput input 12 fields: id, isDeleted, modified, …

Sorting by a field of the related CustomEntity record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
currencyExchangeRatesListIdOrderByEnumId of the currency exchange rate list applied to this record.
nameOrderByEnumName of the entity and its default text representation.
ownerIdOrderByEnumId of the sales user who owns the custom entity record.
shareModeOrderByEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).
typeIdOrderByEnumId of the custom entity type.
unitIdOrderByEnumId of the sales unit.
revisionOrderByEnumRevision when entity was lastly changed.
withCustomCommonEntityRepositoryOrderByCustomFieldSorts by a custom field.
CustomEntityRelationDataRepository object 5 fields: getById, getByIds, getAll, …

Read operations for CustomEntityRelationData records.

FieldTypeDescription
getByIdCustomEntityRelationDataEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CustomEntityRelationDataEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CustomEntityRelationDataEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaCustomEntityRelationDataEntityConnection (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.
CustomEntityRelationRepository object 7 fields: getById, getByIds, getAll, …

Read operations for CustomEntityRelation records.

FieldTypeDescription
getByIdCustomEntityRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CustomEntityRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CustomEntityRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaCustomEntityRelationEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getPublished[CustomEntityRelationEntity!]! (5 args)Returns the published records that match the filter, paged with limit and offset.
getDrafts[CustomEntityRelationEntity!]! (2 args)Returns the records that match the filter, with pending unpublished changes applied where a draft exists.
getDraftByIdCustomEntityRelationEntity! (1 args)Returns the record with the given id, with its pending unpublished changes applied when a draft exists.
CustomEntityRepository object 8 fields: getById, getByIds, getAll, …

Read operations for CustomEntity records.

FieldTypeDescription
getByIdCustomEntityEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CustomEntityEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CustomEntityEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaCustomEntityEntityConnection (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.
getBySessionCustomEntityEntityConnection (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.
autoPrefillCustomEntityEntity! (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.
CustomEntitySharingClientRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for CustomEntitySharingClientRelation records.

FieldTypeDescription
getByIdCustomEntitySharingClientRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CustomEntitySharingClientRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CustomEntitySharingClientRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaCustomEntitySharingClientRelationEntityConnection (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.
CustomEntitySharingSalesUnitRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for CustomEntitySharingSalesUnitRelation records.

FieldTypeDescription
getByIdCustomEntitySharingSalesUnitRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CustomEntitySharingSalesUnitRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CustomEntitySharingSalesUnitRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaCustomEntitySharingSalesUnitRelationEntityConnection (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.
CustomEntityTypeOrderByNestedInput input 7 fields: id, isDeleted, modified, …

Sorting by a field of the related CustomEntityType record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
isReadonlyOrderByEnumTrue when the custom entity type is system-managed and cannot be edited or deleted by users.
nameOrderByEnumName of the entity and its default text representation.
isPublishedOrderByEnumTrue when the entity configuration is published; false while it exists only as an unpublished draft.
CustomEntityTypeRepository object 7 fields: getById, getByIds, getAll, …

Read operations for CustomEntityType records.

FieldTypeDescription
getByIdCustomEntityTypeEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[CustomEntityTypeEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[CustomEntityTypeEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaCustomEntityTypeEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getPublished[CustomEntityTypeEntity!]! (5 args)Returns the published records that match the filter, paged with limit and offset.
getDrafts[CustomEntityTypeEntity!]! (2 args)Returns the records that match the filter, with pending unpublished changes applied where a draft exists.
getDraftByIdCustomEntityTypeEntity! (1 args)Returns the record with the given id, with its pending unpublished changes applied when a draft exists.
CustomField input 16 fields: eq, null, ieq, …

Conditions on a single custom field. Several conditions given together must all match.

Input fieldTypeDescription
eq[String]Exact match (case sensitive). Multiple values in list are evaluated as OR.
nullBooleanTrue matches records where the field has no value; false matches records where it has one.
ieq[String]Exact match (case insensitive). Multiple values in list are evaluated as OR.
emptyBooleanTrue matches records where the text is missing or an empty string; false matches records with a non-empty text.
starts[String]Compare against left side of string (case sensitive). Multiple values in list are evaluated as OR.
ends[String]Compare against right side of string (case sensitive). Multiple values in list are evaluated as OR.
contains[String]Substring match (case sensitive). Multiple values in list are evaluated as OR.
istarts[String]Compare against left side of string (case insensitive). Multiple values in list are evaluated as OR.
iends[String]Compare against right side of string (case insensitive). Multiple values in list are evaluated as OR.
icontains[String]Substring match (case insensitive). Multiple values in list are evaluated as OR.
ltFloatMatches values lower than this number.
lteFloatMatches values lower than or equal to this number.
gtFloatMatches values greater than this number.
gteFloatMatches values greater than or equal to this number.
between[Float]Exactly two values, lower and upper bound. Matches values in this range, including both bounds.
fieldString!Api name of custom field.