The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
input ActivateWorkspaceInput {
"""
Deprecated: the workspace name is set at creation (signUpInNewWorkspace) and this field is ignored during activation. Kept for backward compatibility.
"""
displayName: String
}
input AddQuerySubscriptionInput {
eventStreamId: String!
operationSignature: JSON!
queryId: String!
}
type Agent {
applicationId: UUID
createdAt: DateTime!
description: String
icon: String
id: UUID!
isActive: Boolean!
isCustom: Boolean! @deprecated(reason: "Derived from applicationId and removed in 2.54: compare applicationId with the workspace custom application instead.")
isSystem: Boolean!
label: String!
modelConfiguration: JSON
modelId: String!
name: String!
prompt: String!
responseFormat: JSON
roleId: UUID
triggers: [JSON!]!
updatedAt: DateTime!
}
type AgentChatChannel {
applicationId: UUID!
color: String
icon: String
id: UUID!
isAccessible: Boolean
isCustom: Boolean! @deprecated(reason: "Derived from applicationId and removed in 2.54: compare applicationId with the workspace custom application instead.")
name: String!
position: Float!
roleIds: [UUID!]!
}
enum AgentChatChannelAssignmentFilter {
ANY
ASSIGNED
ASSIGNED_TO_ME
UNASSIGNED
}
type AgentChatChannelRole {
canAccessAllAgentChatChannels: Boolean!
icon: String
id: UUID!
label: String!
}
type AgentChatChannelSummary {
assignedCount: Int!
assignedToMeCount: Int!
channelId: UUID!
doneCount: Int!
hasUnreadAssignedToMe: Boolean!
hasUnreadOpen: Boolean!
mentionedCount: Int!
needsInputCount: Int!
openCount: Int!
snoozedCount: Int!
unassignedCount: Int!
}
enum AgentChatChannelThreadFilter {
ANY
MENTIONED
NEEDS_INPUT
}
type AgentChatChannelThreadIds {
endCursor: String
hasNextPage: Boolean!
threadIds: [UUID!]!
}
enum AgentChatChannelThreadStatus {
DONE
OPEN
SNOOZED
}
type AgentChatEvent {
event: JSON!
threadId: String
}
enum AgentChatInboxAction {
ARCHIVE
MOVE_TO_INBOX
READ
SNOOZE
SUBSCRIBE
UNREAD
UNSUBSCRIBE
}
type AgentChatOpenThreadsSummary {
assignedThreadCount: Int!
assignedToMeThreadCount: Int!
hasUnreadAssignedThread: Boolean!
hasUnreadMentionThread: Boolean!
hasUnreadOpenThread: Boolean!
mentionThreadCount: Int!
needsInputThreadCount: Int!
openThreadCount: Int!
unassignedThreadCount: Int!
unreadOpenThreadCount: Int!
}
type AgentChatThread {
contextWindowTokens: Int
conversationSize: Int!
createdAt: DateTime!
deletedAt: DateTime
id: ID!
title: String
totalCacheReadTokens: Int!
totalInputCredits: Float!
totalInputTokens: Int!
totalOutputCredits: Float!
totalOutputTokens: Int!
updatedAt: DateTime!
}
type AgentChatThreadParticipant {
archivedAt: DateTime
id: UUID!
isSubscribed: Boolean!
lastMentionedAt: DateTime
lastReadAt: DateTime
mentionsResolvedAt: DateTime
snoozedUntil: DateTime
threadId: UUID!
updatedAt: DateTime!
}
input AgentIdInput {
"""The id of the agent."""
id: UUID!
}
type AgentMessage {
agentId: UUID
createdAt: DateTime!
id: UUID!
parts: [AgentMessagePart!]!
processedAt: DateTime
reactions: [AgentMessageReactionSummary!]!
role: String!
senderUserWorkspaceId: UUID
senderWorkspaceMemberId: UUID
status: String!
threadId: UUID!
turnId: UUID
}
type AgentMessagePart {
createdAt: DateTime!
errorMessage: String
fileFilename: String
fileId: UUID
fileMediaType: String
fileUrl: String
id: UUID!
messageId: UUID!
orderIndex: Int!
providerExecuted: Boolean
providerMetadata: JSON
reasoningContent: String
sourceDocumentFilename: String
sourceDocumentMediaType: String
sourceDocumentSourceId: String
sourceDocumentTitle: String
sourceUrlSourceId: String
sourceUrlTitle: String
sourceUrlUrl: String
state: String
textContent: String
toolCallId: String
toolInput: JSON
toolName: String
toolOutput: JSON
type: String!
}
type AgentMessageReactionSummary {
agentIds: [UUID!]!
emoji: String!
hasAssistantReacted: Boolean!
workspaceMemberIds: [UUID!]!
}
type AgentRun {
createdAt: DateTime!
creatorName: String!
creatorSource: String!
credits: Float
endedAt: DateTime
errorMessage: String
id: UUID!
input: String
inputTokens: Int
modelId: String
outputTokens: Int
reply: String
startedAt: DateTime
status: AgentTurnStatus!
threadId: UUID
threadTitle: String
toolNames: [String!]!
}
enum AgentTurnStatus {
CANCELLED
COMPLETED
FAILED
RUNNING
WAITING_FOR_INPUT
}
type AggregateChartConfiguration {
aggregateFieldMetadataId: UUID!
aggregateOperation: AggregateOperations!
configurationType: WidgetConfigurationType!
description: String
displayDataLabel: Boolean
filter: JSON
firstDayOfTheWeek: Int
label: String
numberFormat: ChartNumberFormat
prefix: String
ratioAggregateConfig: RatioAggregateConfig
suffix: String
timezone: String
}
enum AggregateOperations {
AVG
COUNT
COUNT_EMPTY
COUNT_FALSE
COUNT_NOT_EMPTY
COUNT_TRUE
COUNT_UNIQUE_VALUES
MAX
MIN
PERCENTAGE_EMPTY
PERCENTAGE_NOT_EMPTY
SUM
}
enum AiChatAssistantMode {
AUTOMATIC
MENTION_ONLY
NEVER
}
type AiChatUsage {
consumedValue: BigInt
kind: String!
limitValue: BigInt!
periodEnd: DateTime
}
type AiChatUserCreditsUsage {
consumedValue: BigInt
limitValue: BigInt!
periodEnd: DateTime!
}
enum AiModelTier {
balanced
extraFast
extraSmart
fast
smart
}
type AiRunUsage {
inputTokens: Int!
outputTokens: Int!
}
type AiSystemPromptPreview {
estimatedTokenCount: Int!
sections: [AiSystemPromptSection!]!
}
type AiSystemPromptSection {
content: String!
estimatedTokenCount: Int!
title: String!
}
enum AllMetadataName {
agent
agentChatChannel
agentChatChannelRole
applicationVariable
commandMenuItem
connectionProvider
fieldMetadata
fieldPermission
frontComponent
index
logicFunction
mcpServer
messagingProvider
navigationMenuItem
objectMetadata
objectPermission
pageLayout
pageLayoutTab
pageLayoutWidget
permissionFlag
relatedRecordPath
role
rolePermissionFlag
roleTarget
rowLevelPermissionPredicate
rowLevelPermissionPredicateGroup
searchFieldMetadata
settingsMenuItem
skill
timelineActivityType
validationRule
view
viewField
viewFieldGroup
viewFilter
viewFilterGroup
viewGroup
viewSort
webhook
workflow
workflowVersion
}
type Analytics {
"""Boolean that confirms query was dispatched"""
success: Boolean!
}
enum AnalyticsType {
PAGEVIEW
TRACK
}
type ApiConfig {
mutationMaximumAffectedRecords: Float!
}
type ApiKey {
createdAt: DateTime!
expiresAt: DateTime!
id: UUID!
name: String!
revokedAt: DateTime
role: Role!
updatedAt: DateTime!
}
type ApiKeyForRole {
expiresAt: DateTime!
id: UUID!
name: String!
revokedAt: DateTime
}
type ApiKeyToken {
token: String!
}
type AppConnection {
accessToken: String
authFailedAt: String
authFailedReason: String
externalAccountId: String
handle: String!
id: ID!
name: String!
providerName: String!
providerType: String!
scope: ConnectedAccountScope!
scopes: [String!]!
userWorkspaceId: String!
visibility: String! @deprecated(reason: "Use scope instead.")
workspaceMemberId: String
}
type AppKeyValue {
key: String!
scope: AppKeyValueScope!
value: JSON
}
"""
WORKSPACE entries are private to one workspace install of the application. SERVER entries are shared across every install: the value is always the claiming workspaceId and only that workspace can overwrite or delete the key.
"""
enum AppKeyValueScope {
SERVER
WORKSPACE
}
input AppMessageFolderInput {
externalId: String!
isSynced: Boolean
name: String!
}
input AppMessageInput {
externalId: String!
folderExternalIds: [String!]
participants: [AppMessageParticipantInput!]!
receivedAt: DateTime!
subject: String
text: String!
threadExternalId: String!
}
input AppMessageParticipantInput {
displayName: String
handle: String!
personId: UUID
role: MessageParticipantRole!
workspaceMemberId: UUID
}
type Application {
agents: [Agent!]!
applicationRegistration: ApplicationRegistrationSummary
applicationRegistrationId: UUID
applicationVariables: [ApplicationVariable!]!
autoUpgrade: Boolean!
availablePackages: JSON!
canBeUninstalled: Boolean!
commandMenuItems: [CommandMenuItem!]!
createdAt: DateTime!
defaultLogicFunctionRole: Role
defaultRoleId: String
description: String
frontComponents: [FrontComponent!]!
grantedIframeMediaPermissions: [IframeMediaPermission!]!
healthCheckLogicFunctionId: UUID
id: UUID!
isUninstallBlockedByOtherWorkspaceInstallations: Boolean!
logicFunctions: [LogicFunction!]!
logoFileId: UUID
logoUrl: String
name: String!
objects: [Object!]!
packageJsonChecksum: String
packageJsonFileId: UUID
requestedIframeMediaPermissions: [IframeMediaPermission!]!
runOnUserPreferences: Boolean!
settingsCustomTabFrontComponentId: UUID
settingsMenuItems: [SettingsMenuItem!]
universalIdentifier: String!
version: String
yarnLockChecksum: String
yarnLockFileId: UUID
}
type ApplicationAuthorization {
applicationId: UUID!
applicationName: String!
applicationUniversalIdentifier: String
createdAt: DateTime!
id: UUID!
lastAuthorizedAt: DateTime
lastUsedAt: DateTime!
scopes: [String!]
workspaceId: UUID!
}
type ApplicationCapabilityGrant {
grantedCapabilities: [String!]!
id: UUID!
}
type ApplicationConnectedAccountDTO {
applicationId: UUID
archivedAt: DateTime
authFailedAt: DateTime
authFailedReason: String
connectionParameters: PublicImapSmtpCaldavConnectionParameters
connectionProviderId: UUID
createdAt: DateTime!
handle: String!
handleAliases: [String!]
id: UUID!
isOwnedByCurrentUser: Boolean! @deprecated(reason: "Ownership no longer gates connection actions, every application admin manages a workspace-shared connection")
lastCredentialsRefreshedAt: DateTime
lastSignedInAt: DateTime
name: String
provider: String!
scope: ConnectedAccountScope!
scopes: [String!]
updatedAt: DateTime!
userWorkspaceId: UUID!
visibility: String! @deprecated(reason: "Use scope instead.")
}
type ApplicationConnectionProvider {
applicationId: String!
displayName: String!
id: UUID!
logoUrl: String
name: String!
oauth: ApplicationConnectionProviderOAuthConfig
scope: ConnectionProviderScope!
type: String!
}
type ApplicationConnectionProviderOAuthConfig {
isClientCredentialsConfigured: Boolean!
scopes: [String!]!
}
type ApplicationExport {
application: ApplicationExportApplication!
coverage: [ApplicationExportCoverageEntry!]!
files: [ApplicationExportFile!]!
manifest: JSON!
}
type ApplicationExportApplication {
displayName: String!
sourceType: ApplicationRegistrationSourceType!
universalIdentifier: String!
}
type ApplicationExportCoverageEntry {
metadataName: String!
reason: String
status: ApplicationExportCoverageStatus!
universalIdentifier: String!
}
enum ApplicationExportCoverageStatus {
ENGINE_DERIVED
EXCLUDED
EXPORTED
FOREIGN_OWNED
UNSUPPORTED
}
type ApplicationExportFile {
content: String!
folder: String!
path: String!
}
type ApplicationFileCompletionError {
fileId: UUID!
message: String!
}
type ApplicationFileUploadError {
fileFolder: FileFolder!
filePath: String!
message: String!
}
input ApplicationFileUploadRequestInput {
fileFolder: FileFolder!
filePath: String!
size: Int!
}
type ApplicationFileUploadTarget {
contentType: String!
expiresAt: DateTime!
fileFolder: FileFolder!
fileId: UUID!
filePath: String!
uploadUrl: String!
}
type ApplicationHealthCheckAction {
label: String!
location: String
}
type ApplicationHealthCheckResult {
action: ApplicationHealthCheckAction
description: String
status: ApplicationHealthStatus!
title: String
}
enum ApplicationHealthStatus {
ERROR
INFO
NEUTRAL
OK
SUCCESS
UNKNOWN
WARNING
}
type ApplicationMonitoring {
activity: [ApplicationMonitoringActivityBucket!]!
bucketSizeInSeconds: Int!
creditUsage: [ApplicationMonitoringCreditBucket!]
creditsUsed: Float
failedRunCount: Int!
functions: [ApplicationMonitoringFunction!]!
issues: [ApplicationMonitoringIssue!]!
lifecycle: [ApplicationMonitoringLifecycleBucket!]!
lifecycleFailureCount: Int!
lookbackInHours: Int!
periodEnd: DateTime!
periodStart: DateTime!
rateLimitEventCount: Int!
runCount: Int!
versions: [ApplicationMonitoringVersion!]!
}
type ApplicationMonitoringActivityBucket {
bucketStart: DateTime!
errorCount: Int!
rateLimitedJobCount: Int!
rateLimitedRequestCount: Int!
}
type ApplicationMonitoringCreditBucket {
bucketStart: DateTime!
creditsUsed: Float!
operationLabel: String
operationType: String!
}
type ApplicationMonitoringFunction {
failedRunCount: Int!
logicFunctionName: String!
p95DurationMs: Float!
runCount: Int!
}
type ApplicationMonitoringIssue {
affectedInstallCount: Int!
errorCode: String!
eventCount: Int!
lastSeenAt: DateTime!
level: String!
logicFunctionName: String!
source: String!
versions: [String!]!
}
type ApplicationMonitoringLifecycleBucket {
bucketStart: DateTime!
failedCount: Int!
installCount: Int!
uninstallCount: Int!
upgradeCount: Int!
}
type ApplicationMonitoringVersion {
activeInstallCount: Int!
failedRunCount: Int!
runCount: Int!
version: String!
}
type ApplicationPreferences {
applicationId: UUID!
connectionProviders: [ApplicationConnectionProvider!]!
hasUserHealthCheck: Boolean!
settingsMenuItems: [SettingsMenuItem!]!
variables: [UserApplicationVariableValue!]!
}
type ApplicationRegistration {
createdAt: DateTime!
galleryImagesUrls: [String!]!
id: UUID!
isConfigured: Boolean!
isListed: Boolean!
isPreInstalled: Boolean!
latestAvailableVersion: String
logoUrl: String
name: String!
oAuthClientId: String!
oAuthRedirectUris: [String!]!
oAuthScopes: [String!]!
ownerWorkspaceId: UUID
sourcePackage: String
sourceType: ApplicationRegistrationSourceType!
universalIdentifier: String!
updatedAt: DateTime!
}
enum ApplicationRegistrationSourceType {
LOCAL
NPM
OAUTH_ONLY
TARBALL
}
type ApplicationRegistrationStats {
activeInstalls: Int!
autoUpdateEnabled: Int!
creditsUsedBreakdown: [CreditUsedItem!]
mostInstalledVersion: String
suspendedInstalls: Int!
totalCreditsUsed: Float
versionDistribution: [VersionDistributionEntry!]!
}
type ApplicationRegistrationSummary {
id: UUID!
latestAvailableVersion: String
logoUrl: String
sourceType: ApplicationRegistrationSourceType!
}
type ApplicationRegistrationVariable {
createdAt: DateTime!
description: String!
id: UUID!
isDeprecated: Boolean!
isFilled: Boolean!
isRequired: Boolean!
isSecret: Boolean!
key: String!
options: JSON
type: String!
updatedAt: DateTime!
value: String
}
type ApplicationTokenPair {
applicationAccessToken: AuthToken!
applicationRefreshToken: AuthToken!
}
type ApplicationVariable {
description: String!
id: UUID!
isDeprecated: Boolean!
isRequired: Boolean!
isSecret: Boolean!
key: String!
label: String!
options: JSON
scope: ApplicationVariableScope!
type: String!
value: String!
}
enum ApplicationVariableScope {
USER
WORKSPACE
}
type ApprovedAccessDomain {
createdAt: DateTime!
domain: String!
id: UUID!
isValidated: Boolean!
}
type AuthBypassProviders {
google: Boolean!
microsoft: Boolean!
password: Boolean!
}
type AuthProviders {
google: Boolean!
magicLink: Boolean!
microsoft: Boolean!
password: Boolean!
sso: [SSOIdentityProvider!]!
}
type AuthToken {
expiresAt: DateTime!
token: String!
}
type AuthTokenPair {
accessOrWorkspaceAgnosticToken: AuthToken!
refreshToken: AuthToken!
}
type AuthTokens {
tokens: AuthTokenPair!
}
type AuthorizeApp {
redirectUrl: String!
}
type AutocompleteResult {
placeId: String!
text: String!
}
type AvailableWorkspace {
displayName: String
id: UUID!
inviteHash: String
loginToken: String
logo: String
personalInviteToken: String
sso: [SSOConnection!]!
workspaceUrls: WorkspaceUrls!
}
type AvailableWorkspaces {
availableWorkspacesForSignIn: [AvailableWorkspace!]!
availableWorkspacesForSignUp: [AvailableWorkspace!]!
}
type AvailableWorkspacesAndAccessTokens {
availableWorkspaces: AvailableWorkspaces!
tokens: AuthTokenPair!
}
"""Which axes should display labels"""
enum AxisNameDisplay {
BOTH
NONE
X
Y
}
type BarChartConfiguration {
aggregateFieldMetadataId: UUID!
aggregateOperation: AggregateOperations!
axisNameDisplay: AxisNameDisplay
color: String
configurationType: WidgetConfigurationType!
description: String
displayDataLabel: Boolean
displayLegend: Boolean
filter: JSON
firstDayOfTheWeek: Int
groupMode: BarChartGroupMode
isCumulative: Boolean
layout: BarChartLayout!
numberFormat: ChartNumberFormat
omitNullValues: Boolean
primaryAxisDateGranularity: ObjectRecordGroupByDateGranularity
primaryAxisGroupByFieldMetadataId: UUID!
primaryAxisGroupBySubFieldName: String
primaryAxisManualSortOrder: [String!]
primaryAxisOrderBy: GraphOrderBy
rangeMax: Float
rangeMin: Float
secondaryAxisGroupByDateGranularity: ObjectRecordGroupByDateGranularity
secondaryAxisGroupByFieldMetadataId: UUID
secondaryAxisGroupBySubFieldName: String
secondaryAxisManualSortOrder: [String!]
secondaryAxisOrderBy: GraphOrderBy
splitMultiValueFields: Boolean
timezone: String
}
type BarChartData {
data: [JSON!]!
formattedToRawLookup: JSON!
groupMode: BarChartGroupMode!
hasTooManyGroups: Boolean!
indexBy: String!
keys: [String!]!
layout: BarChartLayout!
series: [BarChartSeries!]!
showDataLabels: Boolean!
showLegend: Boolean!
xAxisLabel: String!
yAxisLabel: String!
}
input BarChartDataInput {
configuration: JSON!
objectMetadataId: UUID!
}
"""Display mode for bar charts with secondary grouping"""
enum BarChartGroupMode {
GROUPED
STACKED
}
"""Layout orientation for bar charts"""
enum BarChartLayout {
HORIZONTAL
VERTICAL
}
type BarChartSeries {
key: String!
label: String!
}
"""
The `BigInt` scalar type represents non-fractional signed whole numeric values.
"""
scalar BigInt
type Billing {
billingUrl: String
isBillingEnabled: Boolean!
stripePublishableKey: String
trialPeriods: [BillingTrialPeriod!]!
}
type BillingCustomer {
hasPaymentMethod: Boolean
id: UUID!
userCreditsFallback: UserCreditsFallback!
}
type BillingEndTrialPeriod {
"""
Billing portal URL for payment method update (returned when no payment method exists)
"""
billingPortalUrl: String
"""All billing subscriptions"""
billingSubscriptions: [BillingSubscription!]
"""Updated current billing subscription"""
currentBillingSubscription: BillingSubscription
"""Boolean that confirms if a payment method was found"""
hasPaymentMethod: Boolean!
"""Updated subscription status"""
status: SubscriptionStatus
}
type BillingEntitlement {
key: BillingEntitlementKey!
value: Boolean!
}
enum BillingEntitlementKey {
AUDIT_LOGS
CUSTOM_DOMAIN
CUSTOM_ROLES
RECORD_SHARING
RLS
SSO
USAGE_LIMIT
VALIDATION_RULES
}
type BillingLicensedProduct implements BillingProductDTO {
description: String!
images: [String!]
metadata: BillingProductMetadata!
name: String!
prices: [BillingPriceLicensed!]
}
type BillingMeteredProduct implements BillingProductDTO {
description: String!
images: [String!]
metadata: BillingProductMetadata!
name: String!
prices: [BillingPriceMetered!]
}
type BillingPaymentIntent {
clientSecret: String!
paymentIntentType: String!
}
type BillingPlan {
baseProducts: [BillingLicensedProduct!]!
downgradePlanKeys: [BillingPlanKey!]!
isCheckoutDefault: Boolean!
isSellable: Boolean!
meteredProducts: [BillingMeteredProduct!]!
planKey: BillingPlanKey!
resourceCreditProducts: [BillingLicensedProduct!]!
upgradePlanKeys: [BillingPlanKey!]!
}
"""The different billing plans available"""
enum BillingPlanKey {
ENTERPRISE
ORGANIZATION_V2
PRO
PRO_V2
}
type BillingPriceLicensed {
creditAmount: Float
isSellable: Boolean!
priceUsageType: BillingUsageType!
recurringInterval: SubscriptionInterval!
stripePriceId: String!
unitAmount: Float!
}
type BillingPriceMetered {
priceUsageType: BillingUsageType!
recurringInterval: SubscriptionInterval!
stripePriceId: String!
tiers: [BillingPriceTier!]!
}
type BillingPriceTier {
flatAmount: Float
unitAmount: Float
upTo: Float
}
type BillingProduct {
description: String!
images: [String!]
metadata: BillingProductMetadata!
name: String!
}
interface BillingProductDTO {
description: String!
images: [String!]
metadata: BillingProductMetadata!
name: String!
}
"""The different billing products available"""
enum BillingProductKey {
BASE_PRODUCT
RESOURCE_CREDIT
}
type BillingProductMetadata {
isLegacy: String
planKey: BillingPlanKey!
priceUsageBased: BillingUsageType!
productKey: BillingProductKey!
}
type BillingResourceCreditUsage {
periodEnd: DateTime!
periodStart: DateTime!
productKey: BillingProductKey!
unitPriceCents: Float!
userCreditsUsed: Float!
workspaceCreditsExtraGranted: Float!
workspaceCreditsGranted: Float!
workspaceCreditsGrantedForSeats: Float!
workspaceCreditsSeats: Int!
workspaceCreditsTotalGranted: Float!
workspaceCreditsUsed: Float!
}
type BillingSession {
url: String
}
type BillingSubscription {
billingSubscriptionItems: [BillingSubscriptionItem!]
cancelAt: DateTime
collectionMethod: BillingSubscriptionCollectionMethod
currentPeriodEnd: DateTime
hasUserCredits: Boolean
id: UUID!
interval: SubscriptionInterval
metadata: JSON!
phases: [BillingSubscriptionSchedulePhase!]!
status: SubscriptionStatus!
}
enum BillingSubscriptionCollectionMethod {
CHARGE_AUTOMATICALLY
SEND_INVOICE
}
type BillingSubscriptionItem {
billingProduct: BillingProductDTO!
creditAmount: Float
hasReachedCurrentPeriodCap: Boolean!
id: UUID!
quantity: Float
stripePriceId: String!
unitAmount: Float
}
type BillingSubscriptionSchedulePhase {
end_date: Float!
items: [BillingSubscriptionSchedulePhaseItem!]!
start_date: Float!
}
type BillingSubscriptionSchedulePhaseItem {
price: String!
quantity: Float
}
type BillingTrialPeriod {
duration: Float!
isCreditCardRequired: Boolean!
}
type BillingUpdate {
"""All billing subscriptions"""
billingSubscriptions: [BillingSubscription!]!
"""Current billing subscription"""
currentBillingSubscription: BillingSubscription!
}
enum BillingUsageType {
LICENSED
METERED
}
input BooleanFieldComparison {
is: Boolean
isNot: Boolean
}
type CalendarChannel {
connectedAccountId: UUID!
contactAutoCreationPolicy: CalendarChannelContactAutoCreationPolicy!
createdAt: DateTime!
excludePrivateEvents: Boolean!
handle: String!
id: UUID!
isContactAutoCreationEnabled: Boolean!
isSyncEnabled: Boolean!
syncStage: CalendarChannelSyncStage!
syncStageStartedAt: DateTime
syncStatus: CalendarChannelSyncStatus!
syncedAt: DateTime
throttleFailureCount: Float!
updatedAt: DateTime!
visibility: CalendarChannelVisibility!
}
enum CalendarChannelContactAutoCreationPolicy {
AS_ORGANIZER
AS_PARTICIPANT
AS_PARTICIPANT_AND_ORGANIZER
NONE
}
enum CalendarChannelSyncStage {
CALENDAR_EVENTS_IMPORT_ONGOING
CALENDAR_EVENTS_IMPORT_PENDING
CALENDAR_EVENTS_IMPORT_SCHEDULED
CALENDAR_EVENT_LIST_FETCH_ONGOING
CALENDAR_EVENT_LIST_FETCH_PENDING
CALENDAR_EVENT_LIST_FETCH_SCHEDULED
FAILED
PENDING_CONFIGURATION
}
enum CalendarChannelSyncStatus {
ACTIVE
FAILED_INSUFFICIENT_PERMISSIONS
FAILED_UNKNOWN
NOT_SYNCED
ONGOING
}
enum CalendarChannelVisibility {
METADATA
SHARE_EVERYTHING
}
type CalendarConfiguration {
configurationType: WidgetConfigurationType!
}
type CallRecordingSummaryConfiguration {
configurationType: WidgetConfigurationType!
}
type CallRecordingTranscriptConfiguration {
configurationType: WidgetConfigurationType!
}
type CampaignAudiencePreviewDTO {
duplicateEmails: Int!
globallyUnsubscribed: Int!
hardSuppressed: Int!
sendable: Int!
topicUnsubscribed: Int!
totalMembers: Int!
trackingRefused: Int!
withoutEmail: Int!
}
input CancelMessageCampaignInput {
campaignId: String!
}
type CancelMessageCampaignOutputDTO {
campaignId: String!
canceledMessageCount: Int!
}
type Captcha {
provider: CaptchaDriverType
siteKey: String
}
enum CaptchaDriverType {
GOOGLE_RECAPTCHA
TURNSTILE
}
type ChannelSyncSuccess {
success: Boolean!
}
"""Format used to display the chart value"""
enum ChartNumberFormat {
FULL
SHORT
}
type ChatConfiguration {
configurationType: WidgetConfigurationType!
}
type ChatStreamCatchupChunks {
chunks: [JSON!]!
error: ChatStreamError
maxSeq: Int!
}
type ChatStreamError {
code: String!
message: String!
}
type ChatThreadsConfiguration {
configurationType: WidgetConfigurationType!
}
type CheckUserExist {
availableWorkspacesCount: Float!
exists: Boolean!
isEmailVerified: Boolean!
}
type ClaimableApplicationRegistration {
author: String
description: String
id: String!
isOwned: Boolean!
logoUrl: String
name: String!
sourcePackage: String
universalIdentifier: String!
}
type ClientAiEvaluationModelConfig {
description: String
inputCostPerMillionTokens: Float
isAvailable: Boolean!
isDeprecated: Boolean
label: String!
maxCriteriaPerQuestion: Float
maxScoreLevels: Float
medianLatencyMs: Float
modelId: String!
outputCostPerMillionTokens: Float
providerLabel: String
supportedQuestionTypes: [String!]!
}
type ClientAiModelConfig {
contextWindowTokens: Float
costPerTask: Float
dataResidency: String
effort: String
efforts: [String!]
inputCostPerMillionTokens: Float
intelligenceIndex: Float
isBenchmarkInherited: Boolean
isDeprecated: Boolean
label: String!
maxOutputTokens: Float
modelFamily: ModelFamily
modelFamilyLabel: String
modelId: String!
nativeCapabilities: NativeModelCapabilities
outputCostPerMillionTokens: Float
outputTokensPerSecond: Float
providerLabel: String
providerName: String
sdkPackage: String
}
type ClientAiModelTierConfig {
modelId: String!
tier: AiModelTier!
}
type ClientConfig {
aiEvaluationModels: [ClientAiEvaluationModelConfig!]!
aiModelTiers: [ClientAiModelTierConfig!]!
aiModels: [ClientAiModelConfig!]!
allowRequestsToTwentyIcons: Boolean!
analyticsEnabled: Boolean!
api: ApiConfig!
appVersion: String
authProviders: AuthProviders!
billing: Billing!
calendarBookingPageId: String
canManageFeatureFlags: Boolean!
captcha: Captcha!
defaultSubdomain: String
enterpriseInstanceType: String!
frontDomain: String!
isAttachmentPreviewEnabled: Boolean!
isBookCallOnboardingStepEnabled: Boolean!
isClickHouseConfigured: Boolean!
isCloudflareIntegrationEnabled: Boolean!
isCompanyEnrichmentEnabled: Boolean!
isConfigVariablesInDbEnabled: Boolean!
isCookieSessionEnabled: Boolean!
isEmailVerificationRequired: Boolean!
isEmailingDomainInDemoMode: Boolean!
isGoogleCalendarEnabled: Boolean!
isGoogleMessagingEnabled: Boolean!
isImapSmtpCaldavEnabled: Boolean!
isMicrosoftCalendarEnabled: Boolean!
isMicrosoftMessagingEnabled: Boolean!
isMultiWorkspaceEnabled: Boolean!
isOnboardingAiChatEnabled: Boolean!
isWorkspaceSchemaDDLLocked: Boolean!
maintenance: ClientConfigMaintenanceMode
publicFeatureFlags: [PublicFeatureFlag!]!
publicFunctionDomain: String
sentry: Sentry!
serverUrl: String!
signInPrefilled: Boolean!
support: Support!
}
type ClientConfigMaintenanceMode {
endAt: DateTime!
link: String
startAt: DateTime!
}
type CollectionHash {
collectionName: AllMetadataName!
hash: String!
}
type CommandMenuItem {
applicationId: UUID
availabilityObjectMetadataId: UUID
availabilityType: CommandMenuItemAvailabilityType!
conditionalAvailabilityExpression: String
conditionalPinnedExpression: String
coreWorkflowVersionId: UUID
createdAt: DateTime!
engineComponentKey: EngineComponentKey!
frontComponent: FrontComponent
frontComponentId: UUID
hotKeys: [String!]
icon: String
id: UUID!
isActive: Boolean!
isPinned: Boolean!
label: String!
navigationTargetObjectMetadataId: UUID
pageLayoutId: UUID
payload: CommandMenuItemPayload
position: Float!
shortLabel: String
universalIdentifier: UUID
updatedAt: DateTime!
workflowVersionId: UUID
}
enum CommandMenuItemAvailabilityType {
FALLBACK
GLOBAL
GLOBAL_OBJECT_CONTEXT
RECORD_SELECTION
}
union CommandMenuItemPayload = ObjectMetadataCommandMenuItemPayload | PathCommandMenuItemPayload
type CompleteApplicationFileUploadsResult {
errors: [ApplicationFileCompletionError!]!
files: [File!]!
}
type ConnectedAccountPublicDTO {
applicationId: UUID
archivedAt: DateTime
authFailedAt: DateTime
authFailedReason: String
connectionParameters: PublicImapSmtpCaldavConnectionParameters
connectionProviderId: UUID
createdAt: DateTime!
handle: String!
handleAliases: [String!]
id: UUID!
lastCredentialsRefreshedAt: DateTime
lastSignedInAt: DateTime
name: String
provider: String!
scope: ConnectedAccountScope!
scopes: [String!]
updatedAt: DateTime!
userWorkspaceId: UUID!
visibility: String! @deprecated(reason: "Use scope instead.")
}
enum ConnectedAccountScope {
USER
WORKSPACE
}
type ConnectedImapSmtpCaldavAccount {
connectionParameters: ImapSmtpCaldavPublicConnectionParameters
handle: String!
id: UUID!
provider: String!
userWorkspaceId: UUID!
}
"""Cursor for paging through collections"""
scalar ConnectionCursor
input ConnectionParametersInput {
connectionSecurity: EmailConnectionSecurity
host: String!
password: String
port: Float!
username: String
}
enum ConnectionProviderScope {
USER
WORKSPACE
}
input CreateAgentChatChannelInput {
color: String
icon: String
name: String!
roleIds: [UUID!]! = []
}
input CreateAgentInput {
description: String
icon: String
label: String!
modelConfiguration: JSON
modelId: String!
name: String
prompt: String!
responseFormat: JSON
roleId: UUID
triggers: [JSON!]
}
input CreateApiKeyInput {
expiresAt: String!
name: String!
revokedAt: String
roleId: UUID!
}
input CreateAppMessageChannelInput {
connectedAccountId: UUID!
displayName: String
handle: String!
messagingProviderUniversalIdentifier: UUID
participantHandleFieldUniversalIdentifier: UUID
visibility: MessageChannelVisibility!
}
type CreateApplicationFileUploadsResult {
errors: [ApplicationFileUploadError!]!
targets: [ApplicationFileUploadTarget!]!
}
type CreateApplicationRegistration {
applicationRegistration: ApplicationRegistration!
clientSecret: String!
}
input CreateApplicationRegistrationInput {
name: String!
oAuthRedirectUris: [String!]
oAuthScopes: [String!]
universalIdentifier: String
}
input CreateApprovedAccessDomainInput {
domain: String!
email: String!
}
input CreateCalendarEventInput {
addConferencing: Boolean
attendees: String
connectedAccountId: String!
description: String
endsAt: String!
isFullDay: Boolean
location: String
sendInvitations: Boolean
startsAt: String!
timeZone: String
title: String!
}
type CreateCalendarEventOutput {
calendarEventId: String
conferenceLink: String
error: String
iCalUid: String
success: Boolean!
}
input CreateCommandMenuItemInput {
availabilityObjectMetadataId: UUID
availabilityType: CommandMenuItemAvailabilityType
conditionalAvailabilityExpression: String
conditionalPinnedExpression: String
coreWorkflowVersionId: UUID
engineComponentKey: EngineComponentKey!
frontComponentId: UUID
hotKeys: [String!]
icon: String
isPinned: Boolean
label: String!
navigationTargetObjectMetadataId: UUID
pageLayoutId: UUID
payload: JSON
position: Float
shortLabel: String
workflowVersionId: UUID
}
input CreateEmailGroupChannelInput {
displayName: String
handle: String!
}
type CreateEmailGroupChannelOutput {
forwardingAddress: String!
messageChannel: MessageChannel!
}
input CreateEmailingDomainInput {
domain: String!
}
input CreateFieldInput {
defaultValue: JSON
description: String
icon: String
isActive: Boolean
isAuditLogged: Boolean
isLabelSyncedWithName: Boolean
isNullable: Boolean
isRemoteCreation: Boolean
isSearchable: Boolean
isSystem: Boolean
isUIEditable: Boolean
isUIReadOnly: Boolean
isUnique: Boolean
label: String!
morphRelationsCreationPayload: [JSON!]
name: String!
objectMetadataId: UUID!
options: JSON
relationCreationPayload: JSON
settings: JSON
type: FieldMetadataType!
}
input CreateFrontComponentInput {
builtComponentChecksum: String!
builtComponentPath: String!
componentName: String!
description: String
id: UUID
name: String!
sourceComponentPath: String!
}
input CreateIndexFieldInput {
fieldMetadataId: UUID!
subFieldName: String
}
input CreateIndexInput {
fields: [CreateIndexFieldInput!]!
indexType: IndexType! = BTREE
objectMetadataId: UUID!
}
input CreateLogicFunctionFromSourceInput {
cronTriggerSettings: JSON
databaseEventTriggerSettings: JSON
description: String
httpRouteTriggerSettings: JSON
id: UUID
name: String!
serverRouteTriggerSettings: JSON
source: JSON
timeoutSeconds: Float
toolTriggerSettings: JSON
universalIdentifier: UUID
workflowActionTriggerSettings: JSON
}
input CreateMcpServerInput {
connectionProviderId: UUID
id: UUID
isActive: Boolean
label: String!
name: String!
url: String!
}
input CreateMessageSuppressionInput {
emailAddress: String!
unsubscribeTopicId: UUID
}
input CreateNavigationMenuItemInput {
agentChatChannelId: UUID
color: String
folderId: UUID
icon: String
id: UUID
link: String
name: String
pageLayoutId: UUID
position: Float
targetObjectMetadataId: UUID
targetRecordId: UUID
type: NavigationMenuItemType!
userWorkspaceId: UUID
viewId: UUID
}
input CreateObjectInput {
color: String
description: String
icon: String
isLabelSyncedWithName: Boolean
isRemote: Boolean
labelPlural: String!
labelSingular: String!
namePlural: String!
nameSingular: String!
primaryKeyColumnType: String
primaryKeyFieldMetadataSettings: JSON
shortcut: String
skipNameField: Boolean
}
input CreateOneFieldMetadataInput {
"""The record to create"""
field: CreateFieldInput!
}
input CreateOneIndexInput {
"""The custom index to create"""
index: CreateIndexInput!
}
input CreateOneObjectInput {
"""The object to create"""
object: CreateObjectInput!
}
input CreatePageLayoutInput {
name: String!
objectMetadataId: UUID
type: PageLayoutType = RECORD_PAGE
}
input CreatePageLayoutTabInput {
layoutMode: PageLayoutTabLayoutMode = GRID
pageLayoutId: UUID!
position: Float
title: String!
}
input CreatePageLayoutWidgetInput {
configuration: JSON!
objectMetadataId: UUID
pageLayoutTabId: UUID!
position: JSON
title: String!
type: WidgetType!
}
input CreateRecordExportInput {
fieldMetadataIds: [UUID!]!
filter: JSON
objectMetadataId: UUID!
orderBy: JSON
}
input CreateRelatedRecordPathInput {
firstFieldMetadataId: UUID
isInherent: Boolean
objectMetadataId: UUID
secondFieldMetadataId: UUID
thirdFieldMetadataId: UUID
}
input CreateRoleInput {
canAccessAllAgentChatChannels: Boolean
canAccessAllTools: Boolean
canBeAssignedToAgents: Boolean
canBeAssignedToApiKeys: Boolean
canBeAssignedToUsers: Boolean
canDestroyAllObjectRecords: Boolean
canReadAllObjectRecords: Boolean
canSoftDeleteAllObjectRecords: Boolean
canUpdateAllObjectRecords: Boolean
canUpdateAllSettings: Boolean
description: String
icon: String
id: String
label: String!
}
input CreateSkillInput {
content: String!
description: String
icon: String
id: UUID
label: String!
name: String!
}
input CreateUnsubscribeTopicInput {
description: String
name: String!
visibility: UnsubscribeTopicVisibility
}
input CreateUsageLimitInput {
burstValue: BigInt
limitKind: String!
limitValue: BigInt!
operationType: UsageOperationType!
periodCount: Int!
periodUnit: String!
resourceType: UsageResourceType!
spenderId: String
spenderType: String!
unit: UsageUnit!
}
input CreateValidationRuleInput {
description: String
errorFieldMetadataId: UUID
expression: String!
icon: String
isActive: Boolean
message: String!
name: String!
objectMetadataId: UUID!
}
input CreateViewFieldGroupInput {
id: UUID
isVisible: Boolean = true
name: String!
position: Float = 0
viewId: UUID!
}
input CreateViewFieldInput {
aggregateOperation: AggregateOperations
fieldMetadataId: UUID!
id: UUID
isVisible: Boolean = true
position: Float = 0
size: Float = 0
viewFieldGroupId: UUID
viewId: UUID!
}
input CreateViewFilterGroupInput {
id: UUID
logicalOperator: ViewFilterGroupLogicalOperator = AND
parentViewFilterGroupId: UUID
positionInViewFilterGroup: Float
viewId: UUID!
}
input CreateViewFilterInput {
fieldMetadataId: UUID!
id: UUID
operand: ViewFilterOperand
positionInViewFilterGroup: Float
relationTargetFieldMetadataId: UUID
subFieldName: String
value: JSON!
viewFilterGroupId: UUID
viewId: UUID!
}
input CreateViewGroupInput {
fieldValue: String!
id: UUID
isVisible: Boolean = true
position: Float = 0
viewId: UUID!
}
input CreateViewInput {
anyFieldFilterValue: String
calendarEndFieldMetadataId: UUID
calendarFieldMetadataId: UUID
calendarLayout: ViewCalendarLayout
groupLoadLimit: Int = 8
icon: String!
id: UUID
isCompact: Boolean = false
kanbanAggregateOperation: AggregateOperations
kanbanAggregateOperationFieldMetadataId: UUID
kanbanColumnWidth: Int
key: ViewKey
mainGroupByFieldMetadataId: UUID
name: String!
objectMetadataId: UUID!
"""
Deprecated: Superseded by objectMetadata.openRecordIn and the workspace member preference; kept one release for API compatibility, no longer read by the frontend.
"""
openRecordIn: ViewOpenRecordIn = SIDE_PANEL
position: Float = 0
shouldHideEmptyGroups: Boolean = false
type: ViewType = TABLE
visibility: ViewVisibility
}
input CreateViewSortInput {
direction: ViewSortDirection = ASC
fieldMetadataId: UUID!
id: UUID
subFieldName: String
viewId: UUID!
}
input CreateWebhookInput {
description: String
id: UUID
operations: [String!]!
roleId: UUID!
secret: String
targetUrl: String!
}
type CreditUsedItem {
creditsUsed: Float!
icon: String
label: String
operation: UsageOperationType
resource: UsageResourceType
}
input CursorPaging {
"""Paginate after opaque cursor"""
after: ConnectionCursor
"""Paginate before opaque cursor"""
before: ConnectionCursor
"""Paginate first"""
first: Int
"""Paginate last"""
last: Int
}
"""Database Event Action"""
enum DatabaseEventAction {
CREATED
DELETED
DESTROYED
RESTORED
UPDATED
UPSERTED
}
"""
A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.
"""
scalar DateTime
input DeleteApprovedAccessDomainInput {
id: UUID!
}
input DeleteOneFieldInput {
"""The id of the field to delete."""
id: UUID!
}
input DeleteOneIndexInput {
"""The id of the custom index to delete."""
id: UUID!
}
input DeleteOneObjectInput {
"""The id of the record to delete."""
id: UUID!
}
type DeleteSso {
identityProviderId: UUID!
}
input DeleteSsoInput {
identityProviderId: UUID!
}
type DeleteTwoFactorAuthenticationMethod {
"""Boolean that confirms query was dispatched"""
success: Boolean!
}
input DeleteViewFieldGroupInput {
"""The id of the view field group to delete."""
id: UUID!
}
input DeleteViewFieldInput {
"""The id of the view field to delete."""
id: UUID!
}
input DeleteViewFilterInput {
"""The id of the view filter to delete."""
id: UUID!
}
input DeleteViewGroupInput {
"""The id of the view group to delete."""
id: UUID!
}
input DeleteViewSortInput {
"""The id of the view sort to delete."""
id: UUID!
}
type DeletedWorkspaceMember {
avatarUrl: String
id: UUID!
name: FullName!
userEmail: String!
userWorkspaceId: UUID
}
input DestroyViewFieldGroupInput {
"""The id of the view field group to destroy."""
id: UUID!
}
input DestroyViewFieldInput {
"""The id of the view field to destroy."""
id: UUID!
}
input DestroyViewFilterInput {
"""The id of the view filter to destroy."""
id: UUID!
}
input DestroyViewGroupInput {
"""The id of the view group to destroy."""
id: UUID!
}
input DestroyViewSortInput {
"""The id of the view sort to destroy."""
id: UUID!
}
type DevelopmentApplication {
id: String!
universalIdentifier: String!
}
type DomainRecord {
key: String!
status: String!
type: String!
validationType: String!
value: String!
}
type DomainValidRecords {
domain: String!
id: UUID!
isCustomDomainEnabled: Boolean
records: [DomainRecord!]!
}
type DuplicatedDashboard {
createdAt: String!
id: UUID!
pageLayoutId: UUID
position: Float!
title: String
updatedAt: String!
}
type DuplicatedMessageList {
createdAt: String!
description: String
id: UUID!
memberCount: Float!
name: String
position: Float!
updatedAt: String!
}
type EditSso {
id: UUID!
issuer: String!
name: String!
status: SSOIdentityProviderStatus!
type: IdentityProviderType!
}
input EditSsoInput {
id: UUID!
status: SSOIdentityProviderStatus!
}
input EmailAccountConnectionParameters {
CALDAV: ConnectionParametersInput
IMAP: ConnectionParametersInput
SMTP: ConnectionParametersInput
name: String
}
enum EmailConnectionSecurity {
NONE
SSL_TLS
STARTTLS
}
type EmailPasswordResetLink {
"""Boolean that confirms query was dispatched"""
success: Boolean!
}
type EmailThreadConfiguration {
configurationType: WidgetConfigurationType!
}
type EmailingDomain {
createdAt: DateTime!
domain: String!
id: UUID!
status: EmailingDomainStatus!
tenantStatus: EmailingDomainTenantStatus!
unsubscribeHostnameStatus: UnsubscribeHostnameStatus
updatedAt: DateTime!
verificationRecords: [VerificationRecord!]
verifiedAt: DateTime
}
enum EmailingDomainStatus {
FAILED
PENDING
TEMPORARY_FAILURE
VERIFIED
}
enum EmailingDomainTenantStatus {
ACTIVE
PAUSED
SANDBOX
}
type EmailsConfiguration {
configurationType: WidgetConfigurationType!
}
enum EngineComponentKey {
ACTIVATE_WORKFLOW
ADD_NODE_WORKFLOW
ADD_TO_FAVORITES
ADD_TO_MESSAGE_LIST
ADD_VIEW_TO_MESSAGE_LIST
ASK_AI
ASSIGN_AI_CHAT
CANCEL_DASHBOARD_LAYOUT
CANCEL_MESSAGE_CAMPAIGN
COMPOSE_CAMPAIGN
COMPOSE_EMAIL
CREATE_NEW_RECORD
CREATE_NEW_VIEW
DEACTIVATE_WORKFLOW
DELETE_MULTIPLE_RECORDS
DELETE_RECORDS
DELETE_SINGLE_RECORD
DESTROY_MULTIPLE_RECORDS
DESTROY_RECORDS
DESTROY_SINGLE_RECORD
DISCARD_DRAFT_WORKFLOW
DUPLICATE_DASHBOARD
DUPLICATE_MESSAGE_CAMPAIGN
DUPLICATE_MESSAGE_LIST
DUPLICATE_WORKFLOW
EDIT_DASHBOARD_LAYOUT
EDIT_RECORD_PAGE_LAYOUT
EMAIL_BLOCK_SETTINGS
EMAIL_PAGE_STYLE
EXPORT_FROM_RECORD_INDEX
EXPORT_FROM_RECORD_SHOW
EXPORT_MULTIPLE_RECORDS
EXPORT_RECORDS
EXPORT_VIEW
FRONT_COMPONENT_RENDERER
GO_TO_COMPANIES
GO_TO_DASHBOARDS
GO_TO_NOTES
GO_TO_OPPORTUNITIES
GO_TO_PEOPLE
GO_TO_RUNS
GO_TO_SETTINGS
GO_TO_TASKS
GO_TO_WORKFLOWS
HIDE_DELETED_RECORDS
IMPORT_RECORDS
MARK_AI_CHAT_AS_DONE
MARK_AI_CHAT_AS_READ
MARK_AI_CHAT_AS_UNREAD
MERGE_MULTIPLE_RECORDS
MERGE_WITH_RECORD
NAVIGATE_TO_NEXT_RECORD
NAVIGATE_TO_PREVIOUS_RECORD
NAVIGATION
NEW_AI_CHAT
REMOVE_FROM_FAVORITES
REOPEN_AI_CHAT
REPLY_TO_EMAIL_THREAD
RESTORE_MULTIPLE_RECORDS
RESTORE_RECORDS
RESTORE_SINGLE_RECORD
RETRY_WORKFLOW_RUN
SAVE_DASHBOARD_LAYOUT
SEARCH_RECORDS
SEARCH_RECORDS_FALLBACK
SEE_ACTIVE_VERSION_WORKFLOW
SEE_DELETED_RECORDS
SEE_RUNS_WORKFLOW
SEE_RUNS_WORKFLOW_VERSION
SEE_VERSIONS_WORKFLOW
SEE_VERSIONS_WORKFLOW_VERSION
SEE_VERSION_WORKFLOW_RUN
SEE_WORKFLOW_WORKFLOW_RUN
SEE_WORKFLOW_WORKFLOW_VERSION
SEND_MESSAGE_CAMPAIGN
SEND_MESSAGE_CAMPAIGN_TEST
SHARE_RECORD
SNOOZE_AI_CHAT
STOP_WORKFLOW_RUN
SUBSCRIBE_TO_AI_CHAT
TEST_WORKFLOW
TIDY_UP_WORKFLOW
TOGGLE_WORKFLOW_VISIBILITY
TRIGGER_WORKFLOW_VERSION
UNSUBSCRIBE_FROM_AI_CHAT
UPDATE_MULTIPLE_RECORDS
USE_AS_DRAFT_WORKFLOW_VERSION
VIEW_PREVIOUS_AI_CHATS
}
input EnqueueJobInput {
delayMs: Int
jobId: String
logicFunctionUniversalIdentifier: String!
payload: JSON
retryLimit: Int
}
input EnqueueJobItemInput {
jobId: String
payload: JSON
}
type EnqueueJobResult {
enqueued: Boolean!
jobId: String!
logicFunctionUniversalIdentifier: String!
}
input EnqueueJobsInput {
delayMs: Int
jobs: [EnqueueJobItemInput!]
logicFunctionUniversalIdentifier: String!
payloads: [JSON!] @deprecated(reason: "Use jobs instead.")
retryLimit: Int
}
type EnqueueJobsResult {
enqueued: Boolean!
enqueuedJobsCount: Int!
jobIds: [String!]!
logicFunctionUniversalIdentifier: String!
}
type EnterpriseLicenseInfoDTO {
expiresAt: DateTime
isValid: Boolean!
licensee: String
subscriptionId: String
}
type EnterpriseSubscriptionStatusDTO {
cancelAt: DateTime
currentPeriodEnd: DateTime
expiresAt: DateTime
isCancellationScheduled: Boolean!
licensee: String
status: String!
}
input EventLogDateRangeInput {
end: DateTime
start: DateTime
}
input EventLogFieldFilterInput {
field: String!
operand: EventLogFilterOperand!
values: [String!]!
}
enum EventLogFilterOperand {
IS
IS_NOT
}
input EventLogFiltersInput {
dateRange: EventLogDateRangeInput
eventType: String
fieldFilters: [EventLogFieldFilterInput!]
objectMetadataId: String
recordId: String
userWorkspaceId: String
}
type EventLogPageInfo {
endCursor: String
hasNextPage: Boolean!
}
input EventLogQueryInput {
after: String
filters: EventLogFiltersInput
first: Int = 100
table: EventLogTable!
}
type EventLogQueryResult {
pageInfo: EventLogPageInfo!
records: [EventLogRecord!]!
totalCount: Int!
}
type EventLogRecord {
event: String!
isCustom: Boolean
objectMetadataId: String
properties: JSON
recordId: String
timestamp: DateTime!
userId: String
}
enum EventLogTable {
APPLICATION_LOG
OBJECT_EVENT
PAGEVIEW
USAGE_EVENT
WORKSPACE_EVENT
}
type EventSubscription {
eventStreamId: String!
metadataEvents: [MetadataEvent!]!
objectRecordEventsWithQueryIds: [ObjectRecordEventWithQueryIds!]!
queueJobEvents: [JobStatus!]!
}
input ExecuteOneLogicFunctionInput {
"""Id of the logic function to execute"""
id: UUID!
"""Payload in JSON format"""
payload: JSON!
}
type FeatureFlag {
key: FeatureFlagKey!
value: Boolean!
}
enum FeatureFlagKey {
IS_AGENT_CHAT_DIRECT_MESSAGE_IDENTITY_ENABLED
IS_AI_CHAT_COMPONENT_BUILDER_ENABLED
IS_AI_CHAT_INBOX_ENABLED
IS_APP_PREFERENCES_ENABLED
IS_CALENDAR_EVENT_SHARED_ACROSS_CHANNELS_ENABLED
IS_CONFIGURABLE_SEARCH_FIELDS_ENABLED
IS_GETTING_STARTED_ENABLED
IS_MCP_SERVERS_ENABLED
IS_RECORD_LEVEL_SHARING_ENABLED
IS_RELATED_RECORD_PATHS_ENABLED
IS_REST_METADATA_API_NEW_FORMAT_DIRECT
IS_ROW_LEVEL_PERMISSION_RELATION_HOP_ENABLED
}
type Field {
applicationId: UUID!
createdAt: DateTime!
defaultValue: JSON
description: String
disabledFieldPermissionActions: [String!]
icon: String
id: UUID!
isActive: Boolean
isAuditLogged: Boolean
isLabelSyncedWithName: Boolean
isNullable: Boolean
isSearchable: Boolean
isSystem: Boolean
isSystemSideEffect: Boolean
isUIEditable: Boolean
isUIReadOnly: Boolean @deprecated(reason: "Use isUIEditable")
isUnique: Boolean
label: String!
morphId: UUID
morphRelations: [Relation!]
name: String!
object: Object
objectMetadataId: UUID!
options: JSON
relation: Relation
settings: JSON
type: FieldMetadataType!
universalIdentifier: String!
updatedAt: DateTime!
}
type FieldConfiguration {
configurationType: WidgetConfigurationType!
fieldDisplayMode: FieldDisplayMode!
fieldMetadataId: String!
isUIEditable: Boolean
nestedRelationFieldMetadataId: String
viewId: String
}
type FieldConnection {
"""Array of edges."""
edges: [FieldEdge!]!
"""Paging information"""
pageInfo: PageInfo!
}
"""Display mode for field configuration widgets"""
enum FieldDisplayMode {
CARD
EDITOR
FIELD
TABLE
VIEW
}
type FieldEdge {
"""Cursor for this node."""
cursor: ConnectionCursor!
"""The node containing the Field"""
node: Field!
}
input FieldFilter {
and: [FieldFilter!]
id: UUIDFilterComparison
isActive: BooleanFieldComparison
isSystem: BooleanFieldComparison
isUIEditable: BooleanFieldComparison
isUIReadOnly: BooleanFieldComparison
objectMetadataId: UUIDFilterComparison
or: [FieldFilter!]
}
"""Type of the field"""
enum FieldMetadataType {
ACTOR
ADDRESS
ARRAY
BOOLEAN
CURRENCY
DATE
DATE_TIME
EMAILS
FILES
FULL_NAME
LINKS
MORPH_RELATION
MULTI_SELECT
NUMBER
NUMERIC
PHONES
POSITION
RATING
RAW_JSON
RELATION
RICH_TEXT
SELECT
TEXT
TS_VECTOR
UUID
}
type FieldPermission {
canReadFieldValue: Boolean
canUpdateFieldValue: Boolean
fieldMetadataId: UUID!
id: UUID!
objectMetadataId: UUID!
roleId: UUID!
}
input FieldPermissionInput {
canReadFieldValue: Boolean
canUpdateFieldValue: Boolean
fieldMetadataId: UUID!
objectMetadataId: UUID!
}
type FieldRichTextConfiguration {
configurationType: WidgetConfigurationType!
}
type FieldsConfiguration {
configurationType: WidgetConfigurationType!
newFieldDefaultVisibility: Boolean
shouldAllowUserToSeeHiddenFields: Boolean
viewId: String
}
type File {
createdAt: DateTime!
id: UUID!
path: String!
size: Float!
}
input FileAttachmentInput {
filename: String!
id: UUID!
}
enum FileFolder {
AgentChat
AppTarball
BuiltFrontComponent
BuiltLogicFunction
CorePicture
Dependencies
Dpa
EmailAttachment
EmailImage
FilesField
GeneratedSdkClient
PublicAsset
RecordExport
Source
Workflow
WorkspaceDataExport
}
type FileUploadTarget {
contentType: String!
expiresAt: DateTime!
fileId: UUID!
uploadUrl: String!
}
type FileWithSignedUrl {
createdAt: DateTime!
id: UUID!
path: String!
size: Float!
url: String!
}
type FilesConfiguration {
configurationType: WidgetConfigurationType!
}
type FindAvailableSSOIDP {
id: UUID!
issuer: String!
name: String!
status: SSOIdentityProviderStatus!
type: IdentityProviderType!
workspace: WorkspaceNameAndId!
}
input FindMessageSuppressionsInput {
limit: Int! = 30
offset: Int! = 0
reason: MessageSuppressionReason
searchTerm: String
unsubscribeTopicId: UUID
}
type FormFieldConfiguration {
configurationType: WidgetConfigurationType!
fieldMetadataId: String!
}
type FrontComponent {
applicationGrantedCapabilities: [String!]
applicationGrantedIframeMediaPermissions: [IframeMediaPermission!]
applicationId: UUID!
applicationName: String
applicationTokenPair: ApplicationTokenPair @deprecated(reason: "Use generateFrontComponentApplicationTokenPair")
applicationVariables: JSON
builtComponentChecksum: String!
builtComponentPath: String!
componentName: String!
createdAt: DateTime!
description: String
frontComponentSharedDependenciesChecksum: String
id: UUID!
isHeadless: Boolean!
name: String!
sourceComponentPath: String!
universalIdentifier: UUID
updatedAt: DateTime!
usesSdkClient: Boolean!
widgetAvailability: [FrontComponentWidgetAvailability!]!
}
type FrontComponentConfiguration {
configurationType: WidgetConfigurationType!
frontComponentId: UUID!
headerCommandMenuItemUniversalIdentifiers: [UUID!]
}
type FrontComponentWidgetAvailability {
objectMetadataId: UUID
pageLayoutType: PageLayoutType!
}
type FullName {
firstName: String!
lastName: String!
}
input GenerateInput {
input: [RunAgentMessageInput!]!
instructions: String
modelId: String
responseFormat: JSON
runId: UUID
scope: JSON
}
type GenerateResult {
error: String
object: JSON
runId: UUID!
success: Boolean!
text: String
usage: AiRunUsage!
}
input GetApiKeyInput {
id: UUID!
}
type GetAuthorizationUrlForSSO {
authorizationURL: String!
id: UUID!
type: String!
}
input GetAuthorizationUrlForSSOInput {
identityProviderId: UUID!
workspaceInviteHash: String
}
type GettingStartedProgress {
completedStepActionKeys: [GettingStartedStepActionKey!]!
isHidden: Boolean!
selectedStepActionKey: GettingStartedStepActionKey
snoozedUntil: String
steps: [GettingStartedStepDefinition!]!
}
enum GettingStartedStepActionKey {
CONNECT_MAILBOX
CUSTOMIZE_DATA_MODEL
FOLLOW_UP_DEALS
HANDOVER_DEALS
IMPORT_DATA
INSTALL_APP
INVITE_TEAM
}
type GettingStartedStepDefinition {
actionKey: GettingStartedStepActionKey!
description: String!
doneTitle: String!
icon: String!
iconColor: String!
kind: GettingStartedStepKind!
prompt: String
promptLabel: String
title: String!
}
enum GettingStartedStepKind {
CUSTOM
PROMPT
WORKFLOW
}
type GettingStartedWorkflow {
versionId: String!
workflowId: String!
}
type GettingStartedWorkflowPreview {
actions: [GettingStartedWorkflowPreviewAction!]!
stepActionKey: GettingStartedStepActionKey!
trigger: GettingStartedWorkflowPreviewTrigger!
}
type GettingStartedWorkflowPreviewAction {
title: String!
type: WorkflowActionType!
}
type GettingStartedWorkflowPreviewTrigger {
databaseEventAction: String
title: String!
type: String!
}
input GrantApplicationCapabilitiesInput {
applicationId: UUID!
capabilities: [String!]!
}
"""Order by options for graph widgets"""
enum GraphOrderBy {
FIELD_ASC
FIELD_DESC
FIELD_POSITION_ASC
FIELD_POSITION_DESC
MANUAL
VALUE_ASC
VALUE_DESC
}
type GridPosition {
column: Float!
columnSpan: Float!
row: Float!
rowSpan: Float!
}
enum IdentityProviderType {
OIDC
SAML
}
type IframeConfiguration {
configurationType: WidgetConfigurationType!
url: String
}
type IframeMediaPermission {
camera: Boolean!
microphone: Boolean!
origin: String!
}
input IframeMediaPermissionInput {
camera: Boolean!
microphone: Boolean!
origin: String!
}
type ImapSmtpCaldavConnectionSuccess {
connectedAccountId: String!
success: Boolean!
}
type ImapSmtpCaldavPublicConnectionParameters {
CALDAV: ImapSmtpCaldavPublicConnectionParams
IMAP: ImapSmtpCaldavPublicConnectionParams
SMTP: ImapSmtpCaldavPublicConnectionParams
name: String
}
type ImapSmtpCaldavPublicConnectionParams {
connectionSecurity: EmailConnectionSecurity
host: String!
port: Float!
username: String
}
type Impersonate {
loginToken: AuthToken!
workspace: WorkspaceUrlsAndId!
}
input InboxThreadRecordInput {
objectNameSingular: String!
recordId: UUID!
threadId: UUID!
}
type Index {
applicationId: UUID!
createdAt: DateTime!
id: UUID!
indexFieldMetadataList: [IndexField!]!
indexType: IndexType!
indexWhereClause: String
isCustom: Boolean @deprecated(reason: "Derived from applicationId and removed in 2.54: compare applicationId with the workspace custom application instead.")
isSystemSideEffect: Boolean!
isUnique: Boolean!
name: String!
updatedAt: DateTime!
}
type IndexEdge {
"""Cursor for this node."""
cursor: ConnectionCursor!
"""The node containing the Index"""
node: Index!
}
type IndexField {
createdAt: DateTime!
fieldMetadataId: UUID!
id: UUID!
order: Float!
subFieldName: String
updatedAt: DateTime!
}
input IndexFilter {
and: [IndexFilter!]
id: UUIDFilterComparison
isCustom: BooleanFieldComparison @deprecated(reason: "Derived from applicationId and removed in 2.54: compare applicationId with the workspace custom application instead.")
or: [IndexFilter!]
}
"""Type of the index"""
enum IndexType {
BTREE
GIN
}
input IngestAppMessagesInput {
messageChannelId: UUID!
messages: [AppMessageInput!]!
}
type IngestAppMessagesOutput {
messages: [IngestedAppMessage!]!
}
type IngestedAppMessage {
externalId: String!
messageId: UUID!
messageThreadId: UUID!
}
type InitiateTwoFactorAuthenticationProvisioning {
uri: String!
}
type InvalidatePassword {
"""Boolean that confirms query was dispatched"""
success: Boolean!
}
type InviteSuggestion {
displayName: String
email: String!
}
"""
The `JSON` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).
"""
scalar JSON
"""
The `JSONObject` scalar type represents JSON objects as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).
"""
scalar JSONObject
"""Job state in the queue"""
enum JobState {
ACTIVE
COMPLETED
DELAYED
FAILED
PRIORITIZED
WAITING
WAITING_CHILDREN
}
type JobStatus {
attemptsMade: Int!
enqueuedAt: Float!
failedReason: String
finishedAt: Float
jobId: String!
progress: Int
startedAt: Float
state: JobState!
}
type LineChartConfiguration {
aggregateFieldMetadataId: UUID!
aggregateOperation: AggregateOperations!
axisNameDisplay: AxisNameDisplay
color: String
configurationType: WidgetConfigurationType!
description: String
displayDataLabel: Boolean
displayLegend: Boolean
filter: JSON
firstDayOfTheWeek: Int
isCumulative: Boolean
isStacked: Boolean
numberFormat: ChartNumberFormat
omitNullValues: Boolean
primaryAxisDateGranularity: ObjectRecordGroupByDateGranularity
primaryAxisGroupByFieldMetadataId: UUID!
primaryAxisGroupBySubFieldName: String
primaryAxisManualSortOrder: [String!]
primaryAxisOrderBy: GraphOrderBy
rangeMax: Float
rangeMin: Float
secondaryAxisGroupByDateGranularity: ObjectRecordGroupByDateGranularity
secondaryAxisGroupByFieldMetadataId: UUID
secondaryAxisGroupBySubFieldName: String
secondaryAxisManualSortOrder: [String!]
secondaryAxisOrderBy: GraphOrderBy
splitMultiValueFields: Boolean
timezone: String
}
type LineChartData {
formattedToRawLookup: JSON!
hasTooManyGroups: Boolean!
series: [LineChartSeries!]!
showDataLabels: Boolean!
showLegend: Boolean!
xAxisLabel: String!
yAxisLabel: String!
}
input LineChartDataInput {
configuration: JSON!
objectMetadataId: UUID!
}
type LineChartDataPoint {
x: String!
y: Float!
}
type LineChartSeries {
data: [LineChartDataPoint!]!
key: String!
label: String!
}
input ListAppConnectionsInput {
providerName: String
scope: ConnectedAccountScope
userWorkspaceId: String
visibility: String @deprecated(reason: "Use scope instead.")
}
input ListAppMessageChannelsInput {
connectedAccountId: UUID
}
input ListAppMessageFoldersInput {
messageChannelId: UUID
}
type Location {
lat: Float
lng: Float
}
type LogicFunction {
applicationId: UUID
canRunOnDemand: Boolean
createdAt: DateTime!
cronTriggerSettings: JSON
databaseEventTriggerSettings: JSON
description: String
executionMode: LogicFunctionExecutionMode!
handlerName: String!
httpRouteTriggerSettings: JSON
id: UUID!
name: String!
runtime: String!
sourceHandlerPath: String!
timeoutSeconds: Float!
toolTriggerSettings: JSON
universalIdentifier: UUID
updatedAt: DateTime!
workflowActionTriggerSettings: JSON
}
enum LogicFunctionExecutionMode {
LIVE
PREBUILT
}
type LogicFunctionExecutionResult {
"""Execution result in JSON format"""
data: JSON
"""Execution duration in milliseconds"""
duration: Float!
"""Execution error in JSON format"""
error: JSON
"""Execution Logs"""
logs: String!
"""Execution status"""
status: LogicFunctionExecutionStatus!
}
"""Status of the logic function execution"""
enum LogicFunctionExecutionStatus {
ERROR
IDLE
SUCCESS
}
input LogicFunctionIdInput {
"""The id of the function."""
id: ID!
}
type LogicFunctionLogs {
"""Execution Logs"""
logs: String!
name: String
universalIdentifier: UUID
}
input LogicFunctionLogsInput {
applicationId: UUID
applicationUniversalIdentifier: UUID
id: UUID
name: String
universalIdentifier: UUID
}
type LoginToken {
loginToken: AuthToken!
}
type MarketplaceApp {
author: String!
category: String!
description: String!
id: String!
isListed: Boolean!
logoUrl: String
name: String!
sourcePackage: String
}
type MarketplaceAppDetail {
aboutDescription: String
author: String
billsCredits: Boolean!
category: String
defaultRoleUniversalIdentifier: String
description: String
emailSupport: String
galleryImages: [String!]!
id: String!
installCount: Int!
isListed: Boolean!
issueReportUrl: String
latestAvailableVersion: String
logoUrl: String
manifest: JSON @deprecated(reason: "Use the explicit MarketplaceAppDetail fields (description, author, roles, ...) instead")
name: String!
objects: [MarketplaceAppObject!]
pricingDescription: String
requestedCapabilities: [String!]!
requestedIframeMediaPermissions: [IframeMediaPermission!]!
roles: [MarketplaceAppRole!]
screenshots: [String!]! @deprecated(reason: "Use galleryImages instead")
sourcePackage: String
sourceType: ApplicationRegistrationSourceType!
termsUrl: String
universalIdentifier: String!
websiteUrl: String
}
type MarketplaceAppObject {
labelPlural: String!
labelSingular: String!
universalIdentifier: String!
}
type MarketplaceAppRole {
canAccessAllTools: Boolean
canDestroyAllObjectRecords: Boolean
canReadAllObjectRecords: Boolean
canSoftDeleteAllObjectRecords: Boolean
canUpdateAllObjectRecords: Boolean
canUpdateAllSettings: Boolean
description: String
fieldPermissions: [MarketplaceAppRoleFieldPermission!]
icon: String
label: String!
objectPermissions: [MarketplaceAppRoleObjectPermission!]
permissionFlagUniversalIdentifiers: [String!]
universalIdentifier: String!
}
type MarketplaceAppRoleFieldPermission {
canReadFieldValue: Boolean
canUpdateFieldValue: Boolean
fieldUniversalIdentifier: String!
objectUniversalIdentifier: String!
universalIdentifier: String!
}
type MarketplaceAppRoleObjectPermission {
canDestroyObjectRecords: Boolean
canReadObjectRecords: Boolean
canSoftDeleteObjectRecords: Boolean
canUpdateObjectRecords: Boolean
objectUniversalIdentifier: String!
universalIdentifier: String!
}
type McpServer {
applicationId: UUID!
connectionProviderId: UUID
createdAt: DateTime!
id: UUID!
isActive: Boolean!
label: String!
name: String!
updatedAt: DateTime!
url: String!
}
type MessageCampaignBodyConfiguration {
configurationType: WidgetConfigurationType!
}
type MessageCampaignDetailsConfiguration {
configurationType: WidgetConfigurationType!
}
type MessageCampaignSendBlockerDTO {
code: String!
message: String!
}
type MessageChannel {
connectedAccount: ConnectedAccountPublicDTO
connectedAccountId: UUID!
contactAutoCreationPolicy: MessageChannelContactAutoCreationPolicy!
createdAt: DateTime!
displayName: String
excludeGroupEmails: Boolean!
excludeNonProfessionalEmails: Boolean!
handle: String!
id: UUID!
importProgress: Int
isContactAutoCreationEnabled: Boolean!
isSyncEnabled: Boolean!
messageFolderImportPolicy: MessageFolderImportPolicy!
messagingProviderUniversalIdentifier: UUID
participantHandleFieldUniversalIdentifier: UUID
pendingGroupEmailsAction: MessageChannelPendingGroupEmailsAction!
syncStage: MessageChannelSyncStage!
syncStageStartedAt: DateTime
syncStatus: MessageChannelSyncStatus!
syncedAt: DateTime
throttleFailureCount: Float!
throttleRetryAfter: DateTime
type: MessageChannelType!
updatedAt: DateTime!
visibility: MessageChannelVisibility!
}
enum MessageChannelContactAutoCreationPolicy {
NONE
SENT
SENT_AND_RECEIVED
}
enum MessageChannelPendingGroupEmailsAction {
GROUP_EMAILS_DELETION
GROUP_EMAILS_IMPORT
NONE
}
enum MessageChannelSyncStage {
FAILED
MESSAGES_IMPORT_ONGOING
MESSAGES_IMPORT_PENDING
MESSAGES_IMPORT_SCHEDULED
MESSAGE_LIST_FETCH_ONGOING
MESSAGE_LIST_FETCH_PENDING
MESSAGE_LIST_FETCH_SCHEDULED
PENDING_CONFIGURATION
}
enum MessageChannelSyncStatus {
ACTIVE
FAILED_INSUFFICIENT_PERMISSIONS
FAILED_UNKNOWN
NOT_SYNCED
ONGOING
}
enum MessageChannelType {
APP
EMAIL
EMAIL_GROUP
SMS
}
enum MessageChannelVisibility {
METADATA
SHARE_EVERYTHING
SUBJECT
}
type MessageFolder {
createdAt: DateTime!
externalId: String
id: UUID!
isSentFolder: Boolean!
isSynced: Boolean!
messageChannelId: UUID!
name: String
parentFolderId: String
pendingSyncAction: MessageFolderPendingSyncAction!
updatedAt: DateTime!
}
enum MessageFolderImportPolicy {
ALL_FOLDERS
SELECTED_FOLDERS
}
enum MessageFolderPendingSyncAction {
FOLDER_DELETION
FOLDER_IMPORT
NONE
}
enum MessageParticipantRole {
BCC
CC
FROM
REPLY_TO
TO
}
type MessageSuppression {
createdAt: DateTime!
emailAddress: String!
id: UUID!
reason: MessageSuppressionReason!
source: MessageSuppressionSource!
unsubscribeTopicId: UUID
}
type MessageSuppressionList {
records: [MessageSuppression!]!
totalCount: Int!
}
enum MessageSuppressionReason {
BOUNCE
COMPLAINT
TRACKING
UNSUBSCRIBE
}
enum MessageSuppressionSource {
SYSTEM
WEBHOOK
}
type MetadataEvent {
metadataName: String!
properties: ObjectRecordEventProperties!
recordId: String!
type: MetadataEventAction!
updatedCollectionHash: String
}
"""Metadata Event Action"""
enum MetadataEventAction {
CREATED
DELETED
UPDATED
}
type MetadataTranslation {
canonicalValue: String!
locale: String!
metadataName: String!
objectMetadataId: UUID
property: String!
provenance: MetadataTranslationProvenance!
recordId: UUID!
sourceValue: String!
value: String!
}
input MetadataTranslationOverrideInput {
locale: String!
property: String!
value: String
}
"""
Where a resolved metadata label comes from: a workspace-authored translation, a shipped application catalog, or inheritance from the canonical value
"""
enum MetadataTranslationProvenance {
INHERITED
SHIPPED
WORKSPACE
}
input MetadataTranslationsInput {
fieldMetadataId: UUID
locale: String
objectMetadataId: UUID
}
type MinimalMetadata {
collectionHashes: [CollectionHash!]!
objectMetadataItems: [MinimalObjectMetadata!]!
views: [MinimalView!]!
}
type MinimalObjectMetadata {
color: String
icon: String
id: UUID!
isActive: Boolean!
isRemote: Boolean!
isSystem: Boolean!
labelPlural: String!
labelSingular: String!
namePlural: String!
nameSingular: String!
}
type MinimalView {
id: UUID!
key: ViewKey
objectMetadataId: UUID!
type: ViewType!
}
enum ModelFamily {
CLAUDE
GEMINI
GPT
GROK
MISTRAL
}
type Mutation {
activateSkill(id: UUID!): Skill!
activateWorkspace(data: ActivateWorkspaceInput!): Workspace!
addAgentChatMessageReaction(emoji: String!, messageId: UUID!): [AgentMessageReactionSummary!]!
addQueryToEventStream(input: AddQuerySubscriptionInput!): Boolean!
approveApplicationIframeMediaPermissions(applicationId: UUID!, approvedIframeMediaPermissions: [IframeMediaPermissionInput!]!): Application!
assignAgentChatThread(assigneeWorkspaceMemberId: UUID, threadId: UUID!): Boolean!
assignRoleToAgent(agentId: UUID!, roleId: UUID!): Boolean!
assignRoleToApiKey(apiKeyId: UUID!, roleId: UUID!): Boolean!
attachRecordToInboxThread(input: InboxThreadRecordInput!): Boolean!
authorizeApp(clientId: String!, codeChallenge: String, issuer: String, redirectUrl: String!, scope: String, state: String): AuthorizeApp!
cancelMessageCampaign(input: CancelMessageCampaignInput!): CancelMessageCampaignOutputDTO!
cancelSwitchBillingInterval: BillingUpdate!
cancelSwitchBillingPlan: BillingUpdate!
cancelSwitchResourceCreditPrice: BillingUpdate!
checkCustomDomainValidRecords: DomainValidRecords
checkPublicDomainValidRecords(domain: String!): DomainValidRecords
checkoutSession(plan: BillingPlanKey!, recurringInterval: SubscriptionInterval!, requirePaymentMethod: Boolean! = true, successUrlPath: String): BillingSession!
claimApplicationRegistrationOwnership(applicationRegistrationId: String!): ApplicationRegistration!
completeAppTarballUpload(fileId: UUID!): ApplicationRegistration!
completeApplicationFileUploads(applicationUniversalIdentifier: String!, fileIds: [UUID!]!): CompleteApplicationFileUploadsResult!
completeBookCallOnboardingStep(hasBookedCall: Boolean! = false, isAutoSkipped: Boolean! = false): OnboardingStepSuccess!
completeFileUpload(fileId: String!): FileWithSignedUrl!
completeNewWorkspaceLogoUpload(fileId: String!, workspaceId: String!): FileWithSignedUrl!
completeWorkspaceLogoUpload(fileId: String!): FileWithSignedUrl!
completeWorkspaceMemberProfilePictureUpload(fileId: String!): FileWithSignedUrl!
createAgentChatChannel(input: CreateAgentChatChannelInput!): AgentChatChannel!
createApiKey(input: CreateApiKeyInput!): ApiKey!
createAppMessageChannel(input: CreateAppMessageChannelInput!): MessageChannel!
createApplicationFileUploads(applicationUniversalIdentifier: String!, files: [ApplicationFileUploadRequestInput!]!): CreateApplicationFileUploadsResult!
createApplicationRegistration(input: CreateApplicationRegistrationInput!): CreateApplicationRegistration!
createApprovedAccessDomain(input: CreateApprovedAccessDomainInput!): ApprovedAccessDomain!
createBillingPaymentMethodSetupIntent: BillingPaymentIntent!
createCalendarEvent(input: CreateCalendarEventInput!): CreateCalendarEventOutput!
createChatThread(channelId: UUID): AgentChatThread!
createCommandMenuItem(input: CreateCommandMenuItemInput!): CommandMenuItem!
createDevelopmentApplication(name: String!, universalIdentifier: String!): DevelopmentApplication!
createEmailGroupChannel(input: CreateEmailGroupChannelInput!): CreateEmailGroupChannelOutput!
createEmailingDomain(input: CreateEmailingDomainInput!): EmailingDomain!
createFileUpload(fieldMetadataId: String, fieldMetadataUniversalIdentifier: String, fileFolder: FileFolder!, filename: String!, size: Float!): FileUploadTarget!
createFrontComponent(input: CreateFrontComponentInput!): FrontComponent!
createManyNavigationMenuItems(inputs: [CreateNavigationMenuItemInput!]!): [NavigationMenuItem!]!
createManyViewFieldGroups(inputs: [CreateViewFieldGroupInput!]!): [ViewFieldGroup!]!
createManyViewFields(inputs: [CreateViewFieldInput!]!): [ViewField!]!
createManyViewGroups(inputs: [CreateViewGroupInput!]!): [ViewGroup!]!
createMcpServer(input: CreateMcpServerInput!): McpServer!
createMessageSuppression(input: CreateMessageSuppressionInput!): MessageSuppression!
createNavigationMenuItem(input: CreateNavigationMenuItemInput!): NavigationMenuItem!
createNewWorkspaceLogoUpload(filename: String!, size: Float!, workspaceId: String!): FileUploadTarget!
createOIDCIdentityProvider(input: SetupOIDCSsoInput!): SetupSso!
createObjectEvent(event: String!, objectMetadataId: UUID!, properties: JSON, recordId: UUID!): Analytics!
createOneAgent(input: CreateAgentInput!): Agent!
createOneField(input: CreateOneFieldMetadataInput!): Field!
createOneIndex(input: CreateOneIndexInput!): Index!
createOneLogicFunction(input: CreateLogicFunctionFromSourceInput!): LogicFunction!
createOneObject(input: CreateOneObjectInput!): Object!
createOneRole(createRoleInput: CreateRoleInput!): Role!
createPageLayout(input: CreatePageLayoutInput!): PageLayout!
createPageLayoutTab(input: CreatePageLayoutTabInput!): PageLayoutTab!
createPageLayoutWidget(input: CreatePageLayoutWidgetInput!): PageLayoutWidget!
createPublicDomain(applicationId: String!, domain: String!): PublicDomain!
createRelatedRecordPath(input: CreateRelatedRecordPathInput!): RelatedRecordPath!
createSAMLIdentityProvider(input: SetupSAMLSsoInput!): SetupSso!
createSkill(input: CreateSkillInput!): Skill!
createSubscriptionPaymentIntent(idempotencyKey: String!, plan: BillingPlanKey!, recurringInterval: SubscriptionInterval!, requirePaymentMethod: Boolean! = true, successUrlPath: String): BillingPaymentIntent!
createUnsubscribeTopic(input: CreateUnsubscribeTopicInput!): UnsubscribeTopic!
createUsageLimit(input: CreateUsageLimitInput!): UsageLimit!
createValidationRule(input: CreateValidationRuleInput!): ValidationRule!
createView(input: CreateViewInput!): View!
createViewField(input: CreateViewFieldInput!): ViewField!
createViewFieldGroup(input: CreateViewFieldGroupInput!): ViewFieldGroup!
createViewFilter(input: CreateViewFilterInput!): ViewFilter!
createViewFilterGroup(input: CreateViewFilterGroupInput!): ViewFilterGroup!
createViewGroup(input: CreateViewGroupInput!): ViewGroup!
createViewSort(input: CreateViewSortInput!): ViewSort!
createWebhook(input: CreateWebhookInput!): Webhook!
deactivateSkill(id: UUID!): Skill!
deleteAgentChatChannel(channelId: UUID!, destinationChannelId: UUID): Boolean!
deleteAppKeyValue(key: String!, scope: AppKeyValueScope = WORKSPACE): Boolean!
deleteAppMessageChannel(id: UUID!): MessageChannel!
deleteApplicationRegistration(id: String!): Boolean!
deleteApprovedAccessDomain(input: DeleteApprovedAccessDomainInput!): Boolean!
deleteCommandMenuItem(id: UUID!): CommandMenuItem!
deleteConnectedAccount(id: UUID!): ConnectedAccountPublicDTO!
deleteCurrentWorkspace: Workspace!
deleteEmailGroupChannel(id: UUID!): MessageChannel!
deleteEmailingDomain(id: String!): Boolean!
deleteFrontComponent(id: UUID!): FrontComponent!
deleteManyNavigationMenuItems(ids: [UUID!]!): [NavigationMenuItem!]!
deleteMcpServer(id: UUID!): McpServer!
deleteMessageSuppression(id: UUID!): Boolean!
deleteNavigationMenuItem(id: UUID!): NavigationMenuItem!
deleteOneAgent(input: AgentIdInput!): Agent!
deleteOneField(input: DeleteOneFieldInput!): Field!
deleteOneIndex(input: DeleteOneIndexInput!): Index!
deleteOneLogicFunction(input: LogicFunctionIdInput!): LogicFunction!
deleteOneObject(input: DeleteOneObjectInput!): Object!
deleteOneRole(roleId: UUID!): String!
deletePublicDomain(domain: String!): Boolean!
deleteQueuedChatMessage(messageId: UUID!): Boolean!
deleteRelatedRecordPath(id: UUID!): RelatedRecordPath!
deleteSSOIdentityProvider(input: DeleteSsoInput!): DeleteSso!
deleteSkill(id: UUID!): Skill!
deleteTwoFactorAuthenticationMethod(twoFactorAuthenticationMethodId: UUID!): DeleteTwoFactorAuthenticationMethod!
deleteUnsubscribeTopic(id: String!): Boolean!
deleteUsageLimit(usageLimitId: UUID!): Boolean!
deleteUser: User!
deleteUserFromWorkspace(workspaceMemberIdToDelete: String!): UserWorkspace!
deleteValidationRule(id: UUID!): ValidationRule!
deleteView(id: String!): Boolean!
deleteViewField(input: DeleteViewFieldInput!): ViewField!
deleteViewFieldGroup(input: DeleteViewFieldGroupInput!): ViewFieldGroup!
deleteViewFilter(input: DeleteViewFilterInput!): ViewFilter!
deleteViewFilterGroup(id: String!): Boolean!
deleteViewGroup(input: DeleteViewGroupInput!): ViewGroup!
deleteViewSort(input: DeleteViewSortInput!): Boolean!
deleteWebhook(id: UUID!): Webhook!
deleteWorkspaceInvitation(appTokenId: String!): String!
destroyPageLayout(id: String!): Boolean!
destroyPageLayoutTab(id: String!): Boolean!
destroyPageLayoutWidget(id: String!): Boolean!
destroyView(id: String!): Boolean!
destroyViewField(input: DestroyViewFieldInput!): ViewField!
destroyViewFieldGroup(input: DestroyViewFieldGroupInput!): ViewFieldGroup!
destroyViewFilter(input: DestroyViewFilterInput!): ViewFilter!
destroyViewFilterGroup(id: String!): Boolean!
destroyViewGroup(input: DestroyViewGroupInput!): ViewGroup!
destroyViewSort(input: DestroyViewSortInput!): Boolean!
detachRecordFromInboxThread(input: InboxThreadRecordInput!): Boolean!
disconnectConnectedAccount(id: UUID!): ConnectedAccountPublicDTO!
duplicateDashboard(id: UUID!): DuplicatedDashboard!
duplicateMessageList(id: UUID!): DuplicatedMessageList!
editSSOIdentityProvider(input: EditSsoInput!): EditSso!
emailPasswordResetLink(captchaToken: String, email: String!, workspaceId: UUID): EmailPasswordResetLink!
endSubscriptionTrialPeriod: BillingEndTrialPeriod!
enqueueJob(input: EnqueueJobInput!): EnqueueJobResult! @deprecated(reason: "Use enqueueJobs instead.")
enqueueJobs(input: EnqueueJobsInput!): EnqueueJobsResult!
enrichWorkspaceCompany: WorkspaceCompanyEnrichmentResult!
executeOneLogicFunction(input: ExecuteOneLogicFunctionInput!): LogicFunctionExecutionResult!
generate(input: GenerateInput!): GenerateResult!
generateApiKeyToken(apiKeyId: UUID!, expiresAt: String!): ApiKeyToken!
generateFrontComponentApplicationTokenPair(applicationId: UUID!): ApplicationTokenPair!
generatePlaygroundToken: AuthToken!
generateTransientToken: TransientToken!
generateTwoFactorAuthenticationRecoveryCode(otp: String, userId: UUID!): TwoFactorAuthenticationRecoveryCode!
getAuthTokensFromLoginToken(loginToken: String!, origin: String!): AuthTokens!
getAuthTokensFromOTP(captchaToken: String, loginToken: String!, origin: String!, otp: String!): AuthTokens!
getAuthTokensFromSSOExchangeToken(ssoExchangeToken: String!): AuthTokens!
getAuthTokensFromTwoFactorAuthenticationRecoveryCode(captchaToken: String, loginToken: String!, origin: String!, recoveryCode: String!): TwoFactorAuthenticationRecoveryCodeRedemption!
getAuthorizationUrlForSSO(input: GetAuthorizationUrlForSSOInput!): GetAuthorizationUrlForSSO!
getLoginTokenFromCredentials(captchaToken: String, email: String!, locale: String, origin: String!, password: String!, verifyEmailRedirectPath: String): LoginToken!
goBackToPreviousOnboardingStep: OnboardingStepNavigation!
grantApplicationCapabilities(input: GrantApplicationCapabilitiesInput!): ApplicationCapabilityGrant!
impersonate(userId: UUID!, workspaceId: UUID!): Impersonate!
ingestAppMessages(input: IngestAppMessagesInput!): IngestAppMessagesOutput!
initiateOTPProvisioning(loginToken: String!, origin: String!): InitiateTwoFactorAuthenticationProvisioning!
initiateOTPProvisioningForAuthenticatedUser: InitiateTwoFactorAuthenticationProvisioning!
installApplication(universalIdentifier: String!, version: String): Application!
installMarketplaceApp(universalIdentifier: String!, version: String): Boolean! @deprecated(reason: "Use installApplication instead")
markAgentChatThreadAsDoneInChannel(threadId: UUID!): Boolean!
moveAgentChatThreadToChannel(channelId: UUID, threadId: UUID!): Boolean!
prepareGettingStartedWorkflow(stepActionKey: GettingStartedStepActionKey!): GettingStartedWorkflow!
refreshEnterpriseValidityToken: Boolean!
releaseEnterpriseServerBinding: EnterpriseLicenseInfoDTO!
removeAgentChatMessageReaction(emoji: String!, messageId: UUID!): [AgentMessageReactionSummary!]!
removeQueryFromEventStream(input: RemoveQueryFromEventStreamInput!): Boolean!
removeRecordShare(principal: RecordSharePrincipalInput!, target: RecordTargetInput!): RecordSharingDTO!
removeRoleFromAgent(agentId: UUID!): Boolean!
renewApplicationToken(applicationRefreshToken: String!): ApplicationTokenPair!
renewToken(appToken: String!): AuthTokens!
reopenAgentChatThreadInChannel(threadId: UUID!): Boolean!
reportAppConnectionAuthFailure(input: ReportAppConnectionAuthFailureInput!): Boolean!
resendEmailVerificationToken(email: String!, origin: String!): ResendEmailVerificationToken!
resendWorkspaceInvitation(appTokenId: String!): SendInvitations!
resetCommandMenuItem(id: UUID!): CommandMenuItem!
resetPageLayoutTabToDefault(id: String!): PageLayoutTab!
resetPageLayoutToDefault(id: String!): PageLayout!
resetPageLayoutWidgetToDefault(id: String!): PageLayoutWidget!
resetTimelineActivityType(id: UUID!): TimelineActivityType!
retryChatMessage(modelId: String, threadId: UUID!): SendChatMessageResult!
revokeAllOtherUserSessions: Int!
revokeApiKey(input: RevokeApiKeyInput!): ApiKey
revokeApplicationAuthorization(applicationAuthorizationId: UUID!): Boolean!
revokeTwoFactorAuthenticationRecoveryCode(userId: UUID!): Boolean!
revokeUserSession(userSessionId: UUID!): Boolean!
rotateApplicationRegistrationClientSecret(id: String!): RotateClientSecret!
runAgent(input: RunAgentInput!): RunAgentResult!
runApplicationHealthCheck(applicationId: UUID!): ApplicationHealthCheckResult
runMyApplicationHealthCheck(applicationId: UUID!): ApplicationHealthCheckResult
saveImapSmtpCaldavAccount(connectionParameters: EmailAccountConnectionParameters!, handle: String!, id: UUID): ImapSmtpCaldavConnectionSuccess!
sendAppChannelMessage(input: SendAppChannelMessageInput!): SendAppChannelMessageOutput!
sendChatMessage(browsingContext: JSON, channelId: UUID, fileAttachments: [FileAttachmentInput!], mentionedWorkspaceMemberIds: [UUID!], messageId: UUID!, modelId: String, shouldAssistantReply: Boolean, text: String!, threadId: UUID!): SendChatMessageResult!
sendEmail(input: SendEmailInput!): SendEmailOutput!
sendInboxMessage(input: SendInboxMessageInput!): SendInboxMessageResult!
sendInvitations(emails: [String!]!, roleId: UUID): SendInvitations!
sendMessageCampaign(input: SendMessageCampaignInput!): SendMessageCampaignOutputDTO!
sendMessageCampaignTest(input: SendMessageCampaignTestInput!): SendEmailViaDomainOutput!
setAppKeyValue(input: SetAppKeyValueInput!): AppKeyValue!
setEnterpriseKey(enterpriseKey: String!): EnterpriseLicenseInfoDTO!
setRecordPrivate(isPrivate: Boolean!, target: RecordTargetInput!): RecordSharingDTO!
setRecordShare(accessLevel: RecordShareAccessLevel!, principal: RecordSharePrincipalInput!, target: RecordTargetInput!): RecordSharingDTO!
setResourceCreditSubscriptionPrice(priceId: String!): BillingUpdate!
signIn(captchaToken: String, email: String!, locale: String, password: String!, verifyEmailRedirectPath: String): AvailableWorkspacesAndAccessTokens!
signOut(refreshToken: String): Boolean!
signUp(captchaToken: String, email: String!, locale: String, password: String!, verifyEmailRedirectPath: String): AvailableWorkspacesAndAccessTokens!
signUpInNewWorkspace(input: SignUpInNewWorkspaceInput): SignUp!
signUpInWorkspace(captchaToken: String, email: String!, locale: String, password: String!, verifyEmailRedirectPath: String, workspaceId: UUID, workspaceInviteHash: String, workspacePersonalInviteToken: String): SignUp!
skipSyncEmailOnboardingStep(isAutoSkipped: Boolean! = false): OnboardingStepSuccess!
snoozeAgentChatThreadInChannel(snoozedUntil: DateTime!, threadId: UUID!): Boolean!
startChannelSync(connectedAccountId: UUID!): ChannelSyncSuccess!
startWorkspaceSetupChat(companyContext: JSON, personContext: JSON): StartWorkspaceSetupChatResult!
stopAgentChatStream(threadId: UUID!): Boolean!
stopImpersonation: StopImpersonation!
switchBillingPlan(plan: BillingPlanKey): BillingUpdate!
switchSubscriptionInterval: BillingUpdate!
syncAppMessageFolders(input: SyncAppMessageFoldersInput!): [MessageFolder!]!
syncApplication(dryRun: Boolean, inferDeletionFromMissingEntities: Boolean, manifest: JSON!): WorkspaceMigration!
syncMarketplaceCatalog: Boolean!
trackAnalytics(event: String, name: String, properties: JSON, type: AnalyticsType!): Analytics!
transferApplicationRegistrationOwnership(applicationRegistrationId: String!, targetWorkspaceSubdomain: String!): ApplicationRegistration!
triggerAddPeopleToMessageListJob(input: TriggerAddPeopleToMessageListJobInput!): TriggerAddPeopleToMessageListJobResult!
triggerInstallApplication(input: TriggerInstallApplicationInput!): TriggerInstallApplicationResult!
triggerInstallApplicationJob(input: TriggerInstallApplicationJobInput!): TriggerInstallApplicationJobResult! @deprecated(reason: "Use triggerInstallApplication instead")
triggerUninstallApplication(input: TriggerUninstallApplicationInput!): TriggerUninstallApplicationResult!
triggerUninstallApplicationJob(input: TriggerUninstallApplicationJobInput!): TriggerUninstallApplicationJobResult! @deprecated(reason: "Use triggerUninstallApplication instead")
triggerUpgradeApplication(input: TriggerUpgradeApplicationInput!): TriggerUpgradeApplicationResult!
uninstallApplication(universalIdentifier: String!): Boolean!
updateAgentChatChannel(channelId: UUID!, input: UpdateAgentChatChannelInput!): AgentChatChannel!
updateAgentChatThreadInboxState(action: AgentChatInboxAction!, snoozedUntil: DateTime, threadIds: [UUID!]!): [AgentChatThreadParticipant!]!
updateApiKey(input: UpdateApiKeyInput!): ApiKey
updateAppMessageChannel(input: UpdateAppMessageChannelInput!): MessageChannel!
updateApplication(id: UUID!, input: UpdateApplicationInput!): Application!
updateApplicationRegistration(input: UpdateApplicationRegistrationInput!): ApplicationRegistration!
updateApplicationRegistrationVariable(input: UpdateApplicationRegistrationVariableInput!): ApplicationRegistrationVariable!
updateCalendarChannel(input: UpdateCalendarChannelInput!): CalendarChannel!
updateCommandMenuItem(input: UpdateCommandMenuItemInput!): CommandMenuItem!
updateEmailGroupChannel(input: UpdateEmailGroupChannelInput!): MessageChannel!
updateFrontComponent(input: UpdateFrontComponentInput!): FrontComponent!
updateGettingStarted(input: UpdateGettingStartedInput!): GettingStartedProgress!
updateLabPublicFeatureFlag(input: UpdateLabPublicFeatureFlagInput!): FeatureFlag!
updateManyNavigationMenuItems(inputs: [UpdateOneNavigationMenuItemInput!]!): [NavigationMenuItem!]!
updateManyObjects(inputs: [UpdateOneObjectInput!]!): [Object!]!
updateManyViewGroups(inputs: [UpdateViewGroupInput!]!): [ViewGroup!]!
updateMcpServer(input: UpdateMcpServerInput!): McpServer!
updateMessageChannel(input: UpdateMessageChannelInput!): MessageChannel!
updateMessageFolder(input: UpdateMessageFolderInput!): MessageFolder!
updateMessageFolders(input: UpdateMessageFoldersInput!): [MessageFolder!]!
updateMyUserApplicationVariable(applicationUniversalIdentifier: String!, key: String!, value: String!): Boolean!
updateNavigationMenuItem(input: UpdateOneNavigationMenuItemInput!): NavigationMenuItem!
updateOneAgent(input: UpdateAgentInput!): Agent!
updateOneApplicationVariable(applicationId: UUID, key: String!, value: String!): Boolean!
updateOneField(input: UpdateOneFieldMetadataInput!): Field!
updateOneLogicFunction(input: UpdateLogicFunctionFromSourceInput!): Boolean!
updateOneObject(input: UpdateOneObjectInput!): Object!
updateOneRole(updateRoleInput: UpdateRoleInput!): Role!
updatePageLayout(id: String!, input: UpdatePageLayoutInput!): PageLayout!
updatePageLayoutTab(id: String!, input: UpdatePageLayoutTabInput!): PageLayoutTab!
updatePageLayoutWidget(id: String!, input: UpdatePageLayoutWidgetInput!): PageLayoutWidget!
updatePageLayoutWithTabsAndWidgets(id: String!, input: UpdatePageLayoutWithTabsInput!): PageLayout!
updatePasswordViaResetToken(newPassword: String!, passwordResetToken: String!): InvalidatePassword!
updateSkill(input: UpdateSkillInput!): Skill!
updateTimelineActivityType(input: UpdateTimelineActivityTypeInput!): TimelineActivityType!
updateUnsubscribeTopic(input: UpdateUnsubscribeTopicInput!): UnsubscribeTopic!
updateUsageLimit(input: UpdateUsageLimitInput!): UsageLimit!
updateUserCreditsFallback(userCreditsFallback: UserCreditsFallback!): BillingCustomer!
updateUserEmail(newEmail: String!, verifyEmailRedirectPath: String): Boolean!
updateValidationRule(input: UpdateValidationRuleInput!): ValidationRule!
updateView(id: String!, input: UpdateViewInput!): View!
updateViewField(input: UpdateViewFieldInput!): ViewField!
updateViewFieldGroup(input: UpdateViewFieldGroupInput!): ViewFieldGroup!
updateViewFilter(input: UpdateViewFilterInput!): ViewFilter!
updateViewFilterGroup(id: String!, input: UpdateViewFilterGroupInput!): ViewFilterGroup!
updateViewGroup(input: UpdateViewGroupInput!): ViewGroup!
updateViewSort(input: UpdateViewSortInput!): ViewSort!
updateWebhook(input: UpdateWebhookInput!): Webhook!
updateWorkspace(data: UpdateWorkspaceInput!): Workspace!
updateWorkspaceAllowedEmbeddingOrigins(data: UpdateWorkspaceAllowedEmbeddingOriginsInput!): Workspace!
updateWorkspaceIframeMediaPermissions(data: UpdateWorkspaceIframeMediaPermissionsInput!): Workspace!
updateWorkspaceMemberRole(roleId: UUID!, workspaceMemberId: UUID!): WorkspaceMember!
updateWorkspaceMemberSettings(input: UpdateWorkspaceMemberSettingsInput!): Boolean!
upgradeApplication(appRegistrationId: String!, targetVersion: String!): Boolean!
uploadAppTarball(file: Upload!, universalIdentifier: String @deprecated(reason: "Ignored: the application universalIdentifier is read from the tarball manifest.")): ApplicationRegistration! @deprecated(reason: "Use createFileUpload with the AppTarball folder and completeAppTarballUpload, which send the tarball straight to file storage.")
uploadApplicationFile(applicationUniversalIdentifier: String!, file: Upload!, fileFolder: FileFolder!, filePath: String!): File! @deprecated(reason: "Use createApplicationFileUploads and completeApplicationFileUploads, which send the files straight to file storage.")
uploadFilesFieldFileByUniversalIdentifier(fieldMetadataUniversalIdentifier: String!, file: Upload!): FileWithSignedUrl! @deprecated(reason: "Use createFileUpload with the FilesField folder and the fieldMetadataUniversalIdentifier, then completeFileUpload, which send the file straight to file storage.")
uploadNewWorkspaceLogo(file: Upload!, workspaceId: String!): FileWithSignedUrl! @deprecated(reason: "Use createNewWorkspaceLogoUpload and completeNewWorkspaceLogoUpload, which send the logo straight to file storage.")
uploadWorkspaceLogo(file: Upload!): FileWithSignedUrl! @deprecated(reason: "Use createFileUpload with the CorePicture folder and completeWorkspaceLogoUpload, which send the logo straight to file storage.")
uploadWorkspaceMemberProfilePicture(file: Upload!): FileWithSignedUrl! @deprecated(reason: "Use createFileUpload with the CorePicture folder and completeWorkspaceMemberProfilePictureUpload, which send the picture straight to file storage.")
upsertFieldPermissions(upsertFieldPermissionsInput: UpsertFieldPermissionsInput!): [FieldPermission!]!
upsertFieldsWidget(input: UpsertFieldsWidgetInput!): View!
upsertObjectPermissions(upsertObjectPermissionsInput: UpsertObjectPermissionsInput!): [ObjectPermission!]!
upsertPermissionFlags(upsertPermissionFlagsInput: UpsertPermissionFlagsInput!): [RolePermissionFlag!]!
upsertRowLevelPermissionPredicates(input: UpsertRowLevelPermissionPredicatesInput!): UpsertRowLevelPermissionPredicatesResult!
upsertViewWidget(input: UpsertViewWidgetInput!): View!
validateApprovedAccessDomain(input: ValidateApprovedAccessDomainInput!): ApprovedAccessDomain!
verifyEmailAndGetLoginToken(captchaToken: String, email: String!, emailVerificationToken: String!, origin: String!): VerifyEmailAndGetLoginToken!
verifyEmailAndGetWorkspaceAgnosticToken(captchaToken: String, email: String!, emailVerificationToken: String!): AvailableWorkspacesAndAccessTokens!
verifyEmailingDomain(id: String!): EmailingDomain!
verifyTwoFactorAuthenticationMethodForAuthenticatedUser(otp: String!): VerifyTwoFactorAuthenticationMethod!
}
type NativeModelCapabilities {
twitterSearch: Boolean
webSearch: Boolean
}
type NavigationMenuItem {
agentChatChannelId: UUID
applicationId: UUID
color: String
createdAt: DateTime!
folderId: UUID
icon: String
id: UUID!
link: String
name: String
pageLayoutId: UUID
position: Float!
targetObjectMetadataId: UUID
targetRecordId: UUID
targetRecordIdentifier: RecordIdentifier
type: NavigationMenuItemType!
updatedAt: DateTime!
userWorkspaceId: UUID
viewId: UUID
}
enum NavigationMenuItemType {
AGENT_CHAT_CHANNEL
FOLDER
LINK
OBJECT
PAGE_LAYOUT
RECORD
VIEW
}
type NotesConfiguration {
configurationType: WidgetConfigurationType!
}
type Object {
applicationId: UUID!
color: String
createdAt: DateTime!
description: String
disabledObjectPermissionActions: [String!]
duplicateCriteria: [[String!]!]
fields(
"""Specify to filter the records returned."""
filter: FieldFilter! = {}
"""Limit or page results."""
paging: CursorPaging! = {first: 10}
): ObjectFieldsConnection!
fieldsList: [Field!]!
icon: String
id: UUID!
imageIdentifierFieldMetadataId: UUID
indexMetadataList: [Index!]!
indexMetadatas(
"""Specify to filter the records returned."""
filter: IndexFilter! = {}
"""Limit or page results."""
paging: CursorPaging! = {first: 10}
): ObjectIndexMetadatasConnection!
isActive: Boolean!
isAuditLogged: Boolean!
isLabelSyncedWithName: Boolean!
isRemote: Boolean!
isSearchable: Boolean!
isSystem: Boolean!
isUICreatable: Boolean!
isUIEditable: Boolean!
isUIReadOnly: Boolean! @deprecated(reason: "Use isUIEditable")
labelIdentifierFieldMetadataId: UUID
labelPlural: String!
labelSingular: String!
namePlural: String!
nameSingular: String!
openRecordIn: ObjectOpenRecordIn!
searchFieldMetadataList: [SearchField!]!
shortcut: String
universalIdentifier: String!
updatedAt: DateTime!
}
type ObjectConnection {
"""Array of edges."""
edges: [ObjectEdge!]!
"""Paging information"""
pageInfo: PageInfo!
}
type ObjectEdge {
"""Cursor for this node."""
cursor: ConnectionCursor!
"""The node containing the Object"""
node: Object!
}
type ObjectFieldsConnection {
"""Array of edges."""
edges: [FieldEdge!]!
"""Paging information"""
pageInfo: PageInfo!
}
input ObjectFilter {
and: [ObjectFilter!]
id: UUIDFilterComparison
isActive: BooleanFieldComparison
isRemote: BooleanFieldComparison
isSearchable: BooleanFieldComparison
isSystem: BooleanFieldComparison
isUICreatable: BooleanFieldComparison
isUIEditable: BooleanFieldComparison
isUIReadOnly: BooleanFieldComparison
or: [ObjectFilter!]
universalIdentifier: UUIDFilterComparison
}
type ObjectIndexMetadatasConnection {
"""Array of edges."""
edges: [IndexEdge!]!
"""Paging information"""
pageInfo: PageInfo!
}
type ObjectMetadataCommandMenuItemPayload {
objectMetadataItemId: UUID! @deprecated(reason: "Never returned anymore: navigation targets moved to CommandMenuItem.navigationTargetObjectMetadataId. This variant only remains one release so frontends deployed after the server keep validating; it will be removed in the next release.")
}
enum ObjectOpenRecordIn {
RECORD_PAGE
SIDE_PANEL
USER_CHOICE
}
type ObjectPermission {
canDestroyObjectRecords: Boolean
canReadObjectRecords: Boolean
canSoftDeleteObjectRecords: Boolean
canUpdateObjectRecords: Boolean
objectMetadataId: UUID!
restrictedFields: JSON
rowLevelPermissionPredicateGroups: [RowLevelPermissionPredicateGroup!]
rowLevelPermissionPredicates: [RowLevelPermissionPredicate!]
}
input ObjectPermissionInput {
canDestroyObjectRecords: Boolean
canReadObjectRecords: Boolean
canSoftDeleteObjectRecords: Boolean
canUpdateObjectRecords: Boolean
objectMetadataId: UUID!
}
type ObjectRecordCount {
objectNamePlural: String!
totalCount: Int!
}
type ObjectRecordEvent {
action: DatabaseEventAction!
objectNameSingular: String!
properties: ObjectRecordEventProperties!
recordId: String!
userId: String
workspaceMemberId: String
}
type ObjectRecordEventProperties {
after: JSON
before: JSON
diff: JSON
updatedFields: [String!]
}
type ObjectRecordEventWithQueryIds {
objectRecordEvent: ObjectRecordEvent!
queryIds: [String!]!
}
"""
Date granularity options (e.g. DAY, MONTH, QUARTER, YEAR, WEEK, DAY_OF_THE_WEEK, MONTH_OF_THE_YEAR, QUARTER_OF_THE_YEAR)
"""
enum ObjectRecordGroupByDateGranularity {
DAY
DAY_OF_THE_WEEK
MONTH
MONTH_OF_THE_YEAR
NONE
QUARTER
QUARTER_OF_THE_YEAR
WEEK
YEAR
}
"""Onboarding status"""
enum OnboardingStatus {
BOOK_CALL
COMPLETED
INVITE_TEAM
PLAN_REQUIRED
PROFILE_CREATION
SYNC_EMAIL
WORKSPACE_ACTIVATION
}
type OnboardingStepNavigation {
"""Onboarding status the user landed on"""
onboardingStatus: OnboardingStatus
"""Step the user can go back to from there, if any"""
previousOnboardingStatus: OnboardingStatus
}
type OnboardingStepSuccess {
"""Boolean that confirms query was dispatched"""
success: Boolean!
}
enum OpenRecordIn {
RECORD_PAGE
SIDE_PANEL
}
type PageInfo {
"""The cursor of the last returned record."""
endCursor: ConnectionCursor
"""true if paging forward and there are more records."""
hasNextPage: Boolean
"""true if paging backwards and there are more records."""
hasPreviousPage: Boolean
"""The cursor of the first returned record."""
startCursor: ConnectionCursor
}
type PageLayout {
applicationId: UUID!
createdAt: DateTime!
defaultTabToFocusOnMobileAndSidePanelId: UUID
deletedAt: DateTime
id: UUID!
isFirstTabPinned: Boolean!
isSystemSideEffect: Boolean!
name: String!
objectMetadataId: UUID
tabs: [PageLayoutTab!]
type: PageLayoutType!
universalIdentifier: UUID!
updatedAt: DateTime!
}
type PageLayoutTab {
applicationId: UUID!
createdAt: DateTime!
deletedAt: DateTime
icon: String
id: UUID!
isActive: Boolean!
isOverridden: Boolean @deprecated(reason: "isOverridden is deprecated")
isSystemSideEffect: Boolean!
layoutMode: PageLayoutTabLayoutMode
pageLayoutId: UUID!
position: Float!
title: String!
universalIdentifier: UUID!
updatedAt: DateTime!
widgets: [PageLayoutWidget!]
}
enum PageLayoutTabLayoutMode {
CANVAS @deprecated(reason: "Use VERTICAL_LIST with TAB_VIEWPORT widget height behavior.")
GRID
VERTICAL_LIST
}
enum PageLayoutType {
DASHBOARD
RECORD_FORM
RECORD_INDEX
RECORD_PAGE
STANDALONE_PAGE
}
type PageLayoutWidget {
applicationGrantedIframeMediaPermissions: [IframeMediaPermission!]
applicationId: UUID!
applicationName: String
conditionalAvailabilityExpression: String
conditionalDisplay: JSON
configuration: WidgetConfiguration!
createdAt: DateTime!
deletedAt: DateTime
gridPosition: GridPosition @deprecated(reason: "Use `position` instead.")
id: UUID!
isActive: Boolean!
isOverridden: Boolean @deprecated(reason: "isOverridden is deprecated")
isSystemSideEffect: Boolean!
objectMetadataId: UUID
pageLayoutTabId: UUID!
position: PageLayoutWidgetPosition
title: String!
type: WidgetType!
universalIdentifier: UUID!
updatedAt: DateTime!
}
type PageLayoutWidgetCanvasPosition {
layoutMode: PageLayoutTabLayoutMode!
}
type PageLayoutWidgetGridPosition {
column: Int!
columnSpan: Int!
layoutMode: PageLayoutTabLayoutMode!
row: Int!
rowSpan: Int!
}
union PageLayoutWidgetPosition = PageLayoutWidgetCanvasPosition | PageLayoutWidgetGridPosition | PageLayoutWidgetVerticalListPosition
enum PageLayoutWidgetVerticalListHeightBehavior {
FIT_CONTENT
TAB_VIEWPORT
}
type PageLayoutWidgetVerticalListPosition {
heightBehavior: PageLayoutWidgetVerticalListHeightBehavior
index: Int!
layoutMode: PageLayoutTabLayoutMode!
}
type PathCommandMenuItemPayload {
path: String!
}
type PermissionFlag {
applicationId: UUID!
createdAt: DateTime!
description: String
icon: String
id: UUID!
key: String!
label: String!
permissionType: String!
universalIdentifier: UUID!
updatedAt: DateTime!
}
enum PermissionFlagType {
AI
AI_SETTINGS
API_KEYS_AND_WEBHOOKS
APPLICATIONS
BILLING
CODE_INTERPRETER_TOOL
CONNECTED_ACCOUNTS
CREATE_CALENDAR_EVENT_TOOL
DATA_MODEL
DOWNLOAD_FILE
EXPORT_CSV
HTTP_REQUEST_TOOL
IMPERSONATE
IMPORT_CSV
LAYOUTS
MARKETPLACE_APPS
PROFILE_INFORMATION
ROLES
SECURITY
SEND_EMAIL_TOOL
SSO_BYPASS
UPLOAD_FILE
VIEWS
WORKFLOWS
WORKSPACE
WORKSPACE_MEMBERS
}
type PieChartConfiguration {
aggregateFieldMetadataId: UUID!
aggregateOperation: AggregateOperations!
color: String
configurationType: WidgetConfigurationType!
dateGranularity: ObjectRecordGroupByDateGranularity
description: String
displayDataLabel: Boolean
displayLegend: Boolean
filter: JSON
firstDayOfTheWeek: Int
groupByFieldMetadataId: UUID!
groupBySubFieldName: String
hideEmptyCategory: Boolean
manualSortOrder: [String!]
numberFormat: ChartNumberFormat
orderBy: GraphOrderBy
showCenterMetric: Boolean
splitMultiValueFields: Boolean
timezone: String
}
type PieChartData {
data: [PieChartDataItem!]!
formattedToRawLookup: JSON!
hasTooManyGroups: Boolean!
showCenterMetric: Boolean!
showDataLabels: Boolean!
showLegend: Boolean!
}
input PieChartDataInput {
configuration: JSON!
objectMetadataId: UUID!
}
type PieChartDataItem {
key: String!
value: Float!
}
type PlaceDetailsResult {
city: String
country: String
location: Location
postcode: String
state: String
street: String
}
input PreviewMessageCampaignAudienceInput {
listId: String!
unsubscribeTopicId: String
}
input PreviewMessageCampaignSendInput {
campaignId: String!
scheduledAt: DateTime
}
type PreviewMessageCampaignSendOutputDTO {
audience: CampaignAudiencePreviewDTO
blockers: [MessageCampaignSendBlockerDTO!]!
}
type PublicApplicationRegistration {
id: UUID!
logoUrl: String
name: String!
oAuthScopes: [String!]!
websiteUrl: String
}
type PublicConnectionParametersOutput {
connectionSecurity: EmailConnectionSecurity
host: String!
port: Float!
username: String
}
type PublicDomain {
applicationId: UUID
createdAt: DateTime!
domain: String!
id: UUID!
isValidated: Boolean!
}
type PublicFeatureFlag {
key: FeatureFlagKey!
metadata: PublicFeatureFlagMetadata!
}
type PublicFeatureFlagMetadata {
description: String!
icon: String!
imagePath: String
label: String!
}
type PublicImapSmtpCaldavConnectionParameters {
CALDAV: PublicConnectionParametersOutput
IMAP: PublicConnectionParametersOutput
SMTP: PublicConnectionParametersOutput
}
type PublicWorkspaceData {
authBypassProviders: AuthBypassProviders
authProviders: AuthProviders!
displayName: String
id: UUID!
logo: String
workspaceUrls: WorkspaceUrls!
}
type PublicWorkspaceDataSummary {
displayName: String
id: UUID!
logo: String
}
type Query {
agentChatChannelRoles: [AgentChatChannelRole!]!
agentChatChannelSummaries: [AgentChatChannelSummary!]!
agentChatChannelThreadIds(after: String, assignment: AgentChatChannelAssignmentFilter, channelId: UUID!, filter: AgentChatChannelThreadFilter, first: Int, status: AgentChatChannelThreadStatus): AgentChatChannelThreadIds!
agentChatChannels: [AgentChatChannel!]!
agentChatOpenThreadsSummary: AgentChatOpenThreadsSummary!
agentRuns(agentId: UUID!, limit: Int! = 100): [AgentRun!]!
aiChatUsage: AiChatUsage
aiChatUserCreditsUsage: AiChatUserCreditsUsage
apiKey(input: GetApiKeyInput!): ApiKey
apiKeys: [ApiKey!]!
appConnection(id: ID!): AppConnection!
appConnections(filter: ListAppConnectionsInput): [AppConnection!]!
appKeyValue(key: String!, scope: AppKeyValueScope = WORKSPACE): AppKeyValue
appMessageChannels(filter: ListAppMessageChannelsInput): [MessageChannel!]!
appMessageFolders(filter: ListAppMessageFoldersInput): [MessageFolder!]!
applicationConnectedAccounts(applicationId: UUID!): [ApplicationConnectedAccountDTO!]!
applicationConnectionProviders(applicationId: UUID!): [ApplicationConnectionProvider!]!
applicationCoreGraphqlSchema(applicationUniversalIdentifier: String!): String!
applicationRegistrationTarballUrl(id: String!): String
applicationSdkClientChecksums(applicationId: UUID!): SdkClientChecksums
barChartData(input: BarChartDataInput!): BarChartData!
billingPlans: [BillingPlan!]!
billingPortalSession(forPaymentMethodUpdate: Boolean, returnUrlPath: String): BillingSession!
callRecordingIdForCalendarEvent(calendarEventId: UUID!): UUID
chatMessages(agentUniversalIdentifier: UUID, threadId: UUID, threadKey: String): [AgentMessage!]!
chatStreamCatchupChunks(agentUniversalIdentifier: UUID, threadId: UUID, threadKey: String): ChatStreamCatchupChunks!
chatThread(id: UUID!): AgentChatThread!
checkUserExists(captchaToken: String, email: String!): CheckUserExist!
checkWorkspaceInviteHashIsValid(inviteHash: String!): WorkspaceInviteHashValid!
checkWorkspaceSubdomainAvailability(subdomain: String!): SubdomainAvailabilityDTO!
commandMenuItem(id: UUID!): CommandMenuItem
commandMenuItems: [CommandMenuItem!]!
currentUser: User!
currentUserApplicationAuthorizations: [ApplicationAuthorization!]!
currentUserSessions: [UserSession!]!
currentWorkspace: Workspace!
enterpriseCheckoutSession(billingInterval: String): String
enterprisePortalSession(returnUrlPath: String): String
enterpriseSubscriptionStatus: EnterpriseSubscriptionStatusDTO
eventLogs(input: EventLogQueryInput!): EventLogQueryResult!
exportApplication(shouldIncludeDependencies: Boolean = false, universalIdentifier: UUID!): ApplicationExport!
field(
"""The id of the record to find."""
id: UUID!
): Field!
fields(
"""Specify to filter the records returned."""
filter: FieldFilter! = {}
"""Limit or page results."""
paging: CursorPaging! = {first: 10}
): FieldConnection!
findApplicationRegistrationByClientId(clientId: String!): PublicApplicationRegistration
findApplicationRegistrationByUniversalIdentifier(universalIdentifier: String!): ApplicationRegistration
findApplicationRegistrationMonitoring(id: String!, periodEnd: DateTime, periodStart: DateTime): ApplicationMonitoring!
findApplicationRegistrationStats(id: String!, periodEnd: DateTime, periodStart: DateTime): ApplicationRegistrationStats!
findApplicationRegistrationVariables(applicationRegistrationId: String!): [ApplicationRegistrationVariable!]!
findClaimableApplicationRegistration(sourcePackage: String, universalIdentifier: String): ClaimableApplicationRegistration
findInstallApplicationJobStatus(jobId: String, universalIdentifier: String!): JobStatus
findManyAgents: [Agent!]!
findManyApplicationRegistrations: [ApplicationRegistration!]!
findManyApplications: [Application!]!
findManyLogicFunctions: [LogicFunction!]!
findManyMarketplaceApps(universalIdentifiers: [String!]): [MarketplaceApp!]!
findManyPublicDomains: [PublicDomain!]!
findMarketplaceAppDetail(universalIdentifier: String!): MarketplaceAppDetail!
findOneAgent(input: AgentIdInput!): Agent!
findOneApplication(id: UUID, universalIdentifier: UUID): Application!
findOneApplicationRegistration(id: String!): ApplicationRegistration!
findOneLogicFunction(input: LogicFunctionIdInput!): LogicFunction!
findUninstallApplicationJobStatus(jobId: String, universalIdentifier: String!): JobStatus
findUpgradeApplicationJobStatus(jobId: String, universalIdentifier: String!): JobStatus
findWorkspaceAiStats: WorkspaceAiStats!
findWorkspaceFromInviteHash(inviteHash: String!): Workspace!
findWorkspaceInvitations: [WorkspaceInvitation!]!
frontComponent(id: UUID!): FrontComponent
frontComponents: [FrontComponent!]!
getAddressDetails(placeId: String!, token: String!): PlaceDetailsResult!
getAiSystemPromptPreview: AiSystemPromptPreview!
getApiKeyRoles: [Role!]!
getApprovedAccessDomains: [ApprovedAccessDomain!]!
getAutoCompleteAddress(address: String!, country: String, isFieldCity: Boolean, token: String!): [AutocompleteResult!]!
getAvailablePackages(input: LogicFunctionIdInput!): JSON!
getConnectedImapSmtpCaldavAccount(id: UUID!): ConnectedImapSmtpCaldavAccount!
getEmailingDomains: [EmailingDomain!]!
getInviteSuggestions: [InviteSuggestion!]!
getJobs(jobIds: [String!]!): [JobStatus!]!
getLogicFunctionSourceCode(input: LogicFunctionIdInput!): String
getPageLayout(id: String!): PageLayout
getPageLayoutTab(id: String!): PageLayoutTab!
getPageLayoutTabs(pageLayoutId: String!): [PageLayoutTab!]!
getPageLayoutWidget(id: String!): PageLayoutWidget!
getPageLayoutWidgets(pageLayoutTabId: String!): [PageLayoutWidget!]!
getPageLayouts(objectMetadataId: String, pageLayoutType: PageLayoutType): [PageLayout!]!
getPermissionFlags: [PermissionFlag!]!
getPublicWorkspaceDataByDomain(origin: String): PublicWorkspaceData!
getPublicWorkspaceDataById(id: UUID!): PublicWorkspaceDataSummary!
getResourceCreditUsage: [BillingResourceCreditUsage!]!
getRole(id: UUID!): Role!
getRoles: [Role!]!
getSSOIdentityProviders: [FindAvailableSSOIDP!]!
getToolIndex: [ToolIndexEntry!]!
getToolInputSchema(toolName: String!): JSON
getUsageAnalytics(input: UsageAnalyticsInput): UsageAnalytics!
getView(id: String!): View
getViewField(id: String!): ViewField
getViewFieldGroup(id: String!): ViewFieldGroup
getViewFieldGroups(viewId: String!): [ViewFieldGroup!]!
getViewFields(viewId: String!): [ViewField!]!
getViewFilter(id: String!): ViewFilter
getViewFilterGroup(id: String!): ViewFilterGroup
getViewFilterGroups(viewId: String): [ViewFilterGroup!]!
getViewFilters(viewId: String): [ViewFilter!]!
getViewGroup(id: String!): ViewGroup
getViewGroups(viewId: String): [ViewGroup!]!
getViewSort(id: String!): ViewSort
getViewSorts(viewId: String): [ViewSort!]!
getViews(objectMetadataId: String, viewTypes: [ViewType!]): [View!]!
getWorkspaceCreationDefaults: WorkspaceCreationDefaultsDTO!
gettingStartedProgress: GettingStartedProgress!
gettingStartedWorkflowPreviews: [GettingStartedWorkflowPreview!]!
githubClaimAuthorizationUrl(applicationRegistrationId: String!): String!
isApplicationStopped(applicationUniversalIdentifier: String!): Boolean!
lineChartData(input: LineChartDataInput!): LineChartData!
listPlans: [BillingPlan!]! @deprecated(reason: "Use billingPlans instead.")
mcpServer(id: UUID!): McpServer
mcpServers: [McpServer!]!
messageSuppressions(input: FindMessageSuppressionsInput!): MessageSuppressionList!
metadataTranslations(input: MetadataTranslationsInput!): [MetadataTranslation!]!
minimalMetadata: MinimalMetadata!
mostlyEmptyFieldMetadataIds(objectMetadataId: UUID!): [UUID!]!
myApplicationPreferences: [ApplicationPreferences!]!
myCalendarChannels(connectedAccountId: UUID): [CalendarChannel!]!
myConnectedAccounts: [ConnectedAccountPublicDTO!]!
myMessageChannels(connectedAccountId: UUID): [MessageChannel!]!
myMessageFolders(messageChannelId: UUID): [MessageFolder!]!
myUserApplicationVariables: [WorkspaceMemberApplicationVariables!]!
navigationMenuItem(id: UUID!): NavigationMenuItem
navigationMenuItems: [NavigationMenuItem!]!
object(
"""The id of the record to find."""
id: UUID!
): Object!
objectRecordCounts: [ObjectRecordCount!]!
objects(
"""Specify to filter the records returned."""
filter: ObjectFilter! = {}
"""Limit or page results."""
paging: CursorPaging! = {first: 10}
): ObjectConnection!
pieChartData(input: PieChartDataInput!): PieChartData!
previewMessageCampaignAudience(input: PreviewMessageCampaignAudienceInput!): CampaignAudiencePreviewDTO!
previewMessageCampaignSend(input: PreviewMessageCampaignSendInput!): PreviewMessageCampaignSendOutputDTO!
publicMarketplaceAppDetail(universalIdentifier: String!): MarketplaceAppDetail!
publicMarketplaceApps: [MarketplaceApp!]!
recordPermissions(targets: [RecordTargetInput!]!): [RecordPermissionsResult!]!
recordSharing(target: RecordTargetInput!): RecordSharingDTO!
relatedRecordPaths: [RelatedRecordPath!]!
skill(id: UUID!): Skill
skills: [Skill!]!
timelineActivityTypes: [TimelineActivityType!]!
twoFactorAuthenticationRecoveryStatus(userId: UUID!): TwoFactorAuthenticationRecoveryStatus!
unsubscribeTopics: [UnsubscribeTopic!]!
usageLimits: [UsageLimit!]!
usageQuotaDefinitions: UsageQuotaDefinitions!
usageQuotaScopeConsumption(input: UsageQuotaScopeInput!): UsageQuotaScopeConsumption
usageQuotasWithConsumption: [UsageQuotaWithConsumption!]!
validatePasswordResetToken(passwordResetToken: String!): ValidatePasswordResetToken!
validationRules(objectMetadataId: UUID!): [ValidationRule!]!
validationRulesReadingField(fieldMetadataId: UUID!): [ValidationRule!]!
webhook(id: UUID!): Webhook
webhooks: [Webhook!]!
}
type RatioAggregateConfig {
fieldMetadataId: UUID!
optionValue: String!
}
type RecordExport {
downloadPath: String
errorMessage: String
filename: String!
id: UUID!
progress: Int!
}
type RecordIdentifier {
id: UUID!
imageIdentifier: String
labelIdentifier: String!
}
type RecordPermissionsDTO {
canDelete: Boolean!
canRead: Boolean!
canSoftDelete: Boolean!
canUpdate: Boolean!
}
type RecordPermissionsResult {
objectMetadataId: UUID!
permissions: RecordPermissionsDTO!
recordId: UUID!
}
enum RecordShareAccessLevel {
FULL
NONE
READ
READ_WRITE
}
input RecordSharePrincipalInput {
roleId: UUID
workspaceMemberId: UUID
}
enum RecordSharePrincipalType {
EVERYONE
ROLE
WORKSPACE_MEMBER
}
enum RecordShareRowCause {
APPLICATION
MANUAL
OWNER
RULE
}
type RecordSharingDTO {
canManageSharing: Boolean!
hasManagedGeneralAccess: Boolean!
isPrivate: Boolean!
isShareable: Boolean!
permissions: RecordPermissionsDTO!
roles: [RecordSharingRoleDTO!]!
shares: [RecordSharingGrantDTO!]!
}
type RecordSharingGrantDTO {
accessLevel: RecordShareAccessLevel!
id: ID!
principalId: UUID!
principalRoleId: UUID
principalType: RecordSharePrincipalType!
rowCause: RecordShareRowCause!
}
type RecordSharingRoleDTO {
canRead: Boolean
canUpdate: Boolean
id: UUID!
label: String!
}
type RecordTableConfiguration {
configurationType: WidgetConfigurationType!
isUIEditable: Boolean
recordLimit: Int
viewId: String
}
input RecordTargetInput {
objectMetadataId: UUID!
recordId: UUID!
}
type RelatedRecordPath {
firstFieldMetadataId: UUID!
id: UUID!
isInherent: Boolean!
objectMetadataId: UUID!
secondFieldMetadataId: UUID
thirdFieldMetadataId: UUID
}
type Relation {
sourceFieldMetadata: Field!
sourceObjectMetadata: Object!
targetFieldMetadata: Field!
targetObjectMetadata: Object!
type: RelationType!
}
"""Relation type"""
enum RelationType {
MANY_TO_ONE
ONE_TO_MANY
}
input RemoveQueryFromEventStreamInput {
eventStreamId: String!
queryId: String!
}
input ReportAppConnectionAuthFailureInput {
id: ID!
reason: String
}
type ResendEmailVerificationToken {
success: Boolean!
}
input RevokeApiKeyInput {
id: UUID!
}
type RichTextBody {
blocknote: String @deprecated(reason: "Use markdown or tiptap instead. This value is cleared whenever the field is written in another format.")
markdown: String
tiptap: String
}
type Role {
agents: [Agent!]!
apiKeys: [ApiKeyForRole!]!
applicationId: UUID!
canAccessAllAgentChatChannels: Boolean!
canAccessAllTools: Boolean!
canBeAssignedToAgents: Boolean!
canBeAssignedToApiKeys: Boolean!
canBeAssignedToUsers: Boolean!
canDestroyAllObjectRecords: Boolean!
canReadAllObjectRecords: Boolean!
canSoftDeleteAllObjectRecords: Boolean!
canUpdateAllObjectRecords: Boolean!
canUpdateAllSettings: Boolean!
description: String
fieldPermissions: [FieldPermission!]
icon: String
id: UUID!
isEditable: Boolean!
label: String!
objectPermissions: [ObjectPermission!]
permissionFlags: [RolePermissionFlag!]
rowLevelPermissionPredicateGroups: [RowLevelPermissionPredicateGroup!]
rowLevelPermissionPredicates: [RowLevelPermissionPredicate!]
universalIdentifier: UUID
workspaceMembers: [WorkspaceMember!]!
}
type RolePermissionFlag {
flag: String!
id: UUID!
roleId: UUID!
}
type RotateClientSecret {
clientSecret: String!
}
type RowLevelPermissionPredicate {
fieldMetadataId: String!
id: String!
objectMetadataId: String!
operand: RowLevelPermissionPredicateOperand!
positionInRowLevelPermissionPredicateGroup: Float
relationFieldMetadataId: String
roleId: String!
rowLevelPermissionPredicateGroupId: String
subFieldName: String
value: JSON
workspaceMemberFieldMetadataId: String
workspaceMemberSubFieldName: String
}
type RowLevelPermissionPredicateGroup {
canDestroyRecords: Boolean!
canReadRecords: Boolean!
canSoftDeleteRecords: Boolean!
canUpdateRecords: Boolean!
id: String!
logicalOperator: RowLevelPermissionPredicateGroupLogicalOperator!
objectMetadataId: String!
parentRowLevelPermissionPredicateGroupId: String
positionInRowLevelPermissionPredicateGroup: Float
roleId: String!
}
input RowLevelPermissionPredicateGroupInput {
canDestroyRecords: Boolean
canReadRecords: Boolean
canSoftDeleteRecords: Boolean
canUpdateRecords: Boolean
id: UUID
logicalOperator: RowLevelPermissionPredicateGroupLogicalOperator!
objectMetadataId: UUID!
parentRowLevelPermissionPredicateGroupId: UUID
positionInRowLevelPermissionPredicateGroup: Float
}
enum RowLevelPermissionPredicateGroupLogicalOperator {
AND
OR
}
input RowLevelPermissionPredicateInput {
fieldMetadataId: UUID!
id: UUID
operand: RowLevelPermissionPredicateOperand!
positionInRowLevelPermissionPredicateGroup: Float
relationFieldMetadataId: UUID
rowLevelPermissionPredicateGroupId: UUID
subFieldName: String
value: JSON
workspaceMemberFieldMetadataId: String
workspaceMemberSubFieldName: String
}
enum RowLevelPermissionPredicateOperand {
CONTAINS
DOES_NOT_CONTAIN
GREATER_THAN_OR_EQUAL
IS
IS_AFTER
IS_BEFORE
IS_EMPTY
IS_IN_FUTURE
IS_IN_PAST
IS_NOT
IS_NOT_EMPTY
IS_NOT_NULL
IS_RELATIVE
IS_TODAY
LESS_THAN_OR_EQUAL
VECTOR_SEARCH
}
input RunAgentInput {
additionalInstructions: String
agentUniversalIdentifier: String!
input: [RunAgentMessageInput!]
messages: [RunAgentMessageInput!] @deprecated(reason: "Use input instead.")
prompt: String @deprecated(reason: "Use input instead.")
responseFormat: JSON
runAsWorkspaceMemberId: UUID
thread: RunAgentThreadInput
waitForCompletion: Boolean
}
input RunAgentMessageAttachmentInput {
fileId: UUID!
filename: String
}
input RunAgentMessageInput {
attachments: [RunAgentMessageAttachmentInput!]
content: String!
role: RunAgentMessageRole!
}
enum RunAgentMessageRole {
assistant
user
}
type RunAgentResult {
error: String
result: JSON
runId: UUID!
status: String!
success: Boolean!
threadId: UUID!
}
input RunAgentThreadInput {
key: String!
title: String
}
type SSOConnection {
id: UUID!
issuer: String!
name: String!
status: SSOIdentityProviderStatus!
type: IdentityProviderType!
}
type SSOIdentityProvider {
id: UUID!
issuer: String!
name: String!
status: SSOIdentityProviderStatus!
type: IdentityProviderType!
}
enum SSOIdentityProviderStatus {
Active
Error
Inactive
}
type SdkClientChecksums {
core: String
metadata: String!
}
type SearchField {
createdAt: DateTime!
fieldMetadataId: UUID!
id: UUID!
position: Float!
tsVectorFieldMetadataId: UUID!
updatedAt: DateTime!
}
input SendAppChannelMessageInput {
idempotencyKey: UUID!
messageChannelId: UUID!
messageThreadId: UUID!
text: String!
}
type SendAppChannelMessageOutput {
messageId: UUID!
messageThreadId: UUID!
}
type SendChatMessageResult {
mentionedParticipantWorkspaceMemberIds: [UUID!]
messageId: String
queued: Boolean!
streamId: String
}
input SendEmailAttachmentInput {
id: String!
name: String!
}
input SendEmailInput {
bcc: String
body: String!
cc: String
connectedAccountId: String!
draftMessageId: String
files: [SendEmailAttachmentInput!]
fromHandle: String
inReplyTo: String
subject: String!
targetRecord: SendEmailTargetRecordInput
to: String!
}
type SendEmailOutput {
error: String
messageThreadId: String
success: Boolean!
}
input SendEmailTargetRecordInput {
objectNameSingular: String!
recordId: UUID!
}
type SendEmailViaDomainOutput {
messageId: String!
}
input SendInboxMessageInput {
idempotencyKey: String!
text: String!
threadKey: String!
title: String!
toolCall: JSON
workspaceMemberIds: [UUID!]!
}
type SendInboxMessageResult {
threadId: UUID!
}
type SendInvitations {
errors: [String!]!
result: [WorkspaceInvitation!]!
"""Boolean that confirms query was dispatched"""
success: Boolean!
}
input SendMessageCampaignInput {
campaignId: String!
scheduledAt: DateTime
}
type SendMessageCampaignOutputDTO {
audience: CampaignAudiencePreviewDTO!
campaignId: String!
queuedCount: Int!
}
input SendMessageCampaignTestInput {
body: String!
fromAddress: String!
subject: String!
toAddress: String!
unsubscribeTopicId: String
}
type Sentry {
dsn: String
environment: String
release: String
tracesSampleRate: Float
}
input SetAppKeyValueInput {
key: String!
scope: AppKeyValueScope = WORKSPACE
value: JSON
}
type SettingsMenuItem {
applicationId: UUID!
createdAt: DateTime!
frontComponentId: UUID!
icon: String
id: UUID!
position: Float!
scope: SettingsMenuItemScope!
slug: String
title: String!
universalIdentifier: UUID!
updatedAt: DateTime!
}
enum SettingsMenuItemScope {
USER
WORKSPACE
}
input SetupOIDCSsoInput {
clientID: String!
clientSecret: String!
issuer: String!
name: String!
}
input SetupSAMLSsoInput {
certificate: String!
fingerprint: String
id: UUID!
issuer: String!
name: String!
ssoURL: String!
}
type SetupSso {
id: UUID!
issuer: String!
name: String!
status: SSOIdentityProviderStatus!
type: IdentityProviderType!
}
type SignUp {
loginToken: AuthToken!
workspace: WorkspaceUrlsAndId!
}
input SignUpInNewWorkspaceInput {
captchaToken: String
displayName: String
partner: String
subdomain: String
}
type Skill {
applicationId: UUID
content: String!
createdAt: DateTime!
description: String
icon: String
id: UUID!
isActive: Boolean!
isCustom: Boolean! @deprecated(reason: "Derived from applicationId and removed in 2.54: compare applicationId with the workspace custom application instead.")
isSystem: Boolean!
label: String!
name: String!
updatedAt: DateTime!
}
type StandaloneRichTextConfiguration {
body: RichTextBody!
configurationType: WidgetConfigurationType!
}
type StartWorkspaceSetupChatResult {
outcome: WorkspaceSetupChatOutcome!
thread: AgentChatThread
}
type StopImpersonation {
canRestoreImpersonatorSession: Boolean!
}
type SubdomainAvailabilityDTO {
available: Boolean!
isValid: Boolean!
suggestedSubdomain: String!
suggestedSubdomains: [String!]!
}
type Subscription {
eventLogsLive(fieldFilters: [EventLogFieldFilterInput!], table: EventLogTable!): [EventLogRecord!]
exportRecords(input: CreateRecordExportInput!): RecordExport!
logicFunctionLogs(input: LogicFunctionLogsInput!): LogicFunctionLogs!
onAgentChatEvent(agentUniversalIdentifier: UUID, runId: UUID, threadId: UUID, threadKey: String): AgentChatEvent!
onEventSubscription(eventStreamId: String!): EventSubscription
}
enum SubscriptionInterval {
Month
Year
}
enum SubscriptionStatus {
Active
Canceled
Incomplete
IncompleteExpired
PastDue
Paused
Trialing
Unpaid
}
type Support {
supportDriver: SupportDriver!
supportFrontChatId: String
}
enum SupportDriver {
FRONT
NONE
}
input SyncAppMessageFoldersInput {
folders: [AppMessageFolderInput!]!
messageChannelId: UUID!
}
type TasksConfiguration {
configurationType: WidgetConfigurationType!
}
type TimelineActivityType {
action: String @deprecated(reason: "Use emit.on")
applicationId: UUID
createdAt: DateTime!
emit: TimelineActivityTypeEmit
frontComponentUniversalIdentifier: UUID
icon: String
id: UUID!
isActive: Boolean!
label: String!
name: String!
objectUniversalIdentifier: UUID @deprecated(reason: "Use emit.objectUniversalIdentifier")
replacesTimelineActivityTypeUniversalIdentifier: UUID
universalIdentifier: UUID!
updatedAt: DateTime!
}
type TimelineActivityTypeEmit {
objectUniversalIdentifier: UUID
on: String!
through: TimelineActivityTypeEmitThrough
}
type TimelineActivityTypeEmitThrough {
happensAtFieldUniversalIdentifier: UUID
relationFieldUniversalIdentifier: UUID!
triggerFieldUniversalIdentifiers: [UUID!]
}
type TimelineConfiguration {
configurationType: WidgetConfigurationType!
}
type ToolIndexEntry {
category: String!
description: String!
frontComponentId: String
icon: String
inputSchema: JSON
label: String!
name: String!
objectName: String
widgetName: String
}
type TransientToken {
transientToken: AuthToken!
}
input TriggerAddPeopleToMessageListJobInput {
messageListId: UUID!
personFilter: JSON!
}
type TriggerAddPeopleToMessageListJobResult {
jobId: String!
}
input TriggerInstallApplicationInput {
universalIdentifier: String!
}
input TriggerInstallApplicationJobInput {
universalIdentifier: String!
}
type TriggerInstallApplicationJobResult {
jobId: String!
}
type TriggerInstallApplicationResult {
jobId: String!
}
input TriggerUninstallApplicationInput {
universalIdentifier: String!
}
input TriggerUninstallApplicationJobInput {
universalIdentifier: String!
}
type TriggerUninstallApplicationJobResult {
jobId: String!
}
type TriggerUninstallApplicationResult {
jobId: String!
}
input TriggerUpgradeApplicationInput {
targetVersion: String!
universalIdentifier: String!
}
type TriggerUpgradeApplicationResult {
jobId: String!
}
type TwoFactorAuthenticationMethodSummary {
status: String!
strategy: String!
twoFactorAuthenticationMethodId: UUID!
}
type TwoFactorAuthenticationRecoveryCode {
expiresAt: DateTime!
recoveryCode: String!
}
type TwoFactorAuthenticationRecoveryCodeRedemption {
provisioningUri: String
tokens: AuthTokenPair
}
type TwoFactorAuthenticationRecoveryStatus {
hasVerifiedTwoFactorAuthenticationMethod: Boolean!
isAwaitingRecoveryEnrollment: Boolean!
pendingRecoveryCodeExpiresAt: DateTime
}
"""A UUID scalar type"""
scalar UUID
input UUIDFilterComparison {
eq: UUID
gt: UUID
gte: UUID
iLike: UUID
in: [UUID!]
is: Boolean
isNot: Boolean
like: UUID
lt: UUID
lte: UUID
neq: UUID
notILike: UUID
notIn: [UUID!]
notLike: UUID
}
enum UnsubscribeHostnameStatus {
ACTIVE
FAILED
PENDING
}
type UnsubscribeTopic {
createdAt: DateTime!
description: String
id: UUID!
name: String
updatedAt: DateTime!
visibility: UnsubscribeTopicVisibility!
}
enum UnsubscribeTopicVisibility {
PRIVATE
PUBLIC
}
input UpdateAgentChatChannelInput {
color: String
icon: String
name: String
position: Float
roleIds: [UUID!]
}
input UpdateAgentInput {
description: String
icon: String
id: UUID!
isActive: Boolean
label: String
modelConfiguration: JSON
modelId: String
name: String
prompt: String
responseFormat: JSON
roleId: UUID
triggers: [JSON!]
}
input UpdateApiKeyInput {
expiresAt: String
id: UUID!
name: String
revokedAt: String
}
input UpdateAppMessageChannelInput {
displayName: String
id: UUID!
isSyncEnabled: Boolean
messagingProviderUniversalIdentifier: UUID
visibility: MessageChannelVisibility
}
input UpdateApplicationInput {
autoUpgrade: Boolean
}
input UpdateApplicationRegistrationInput {
id: String!
update: UpdateApplicationRegistrationPayload!
}
input UpdateApplicationRegistrationPayload {
name: String
oAuthRedirectUris: [String!]
oAuthScopes: [String!]
}
input UpdateApplicationRegistrationVariableInput {
id: String!
update: UpdateApplicationRegistrationVariablePayload!
}
input UpdateApplicationRegistrationVariablePayload {
description: String
resetValue: Boolean
value: String
}
input UpdateCalendarChannelInput {
id: UUID!
update: UpdateCalendarChannelInputUpdates!
}
input UpdateCalendarChannelInputUpdates {
contactAutoCreationPolicy: CalendarChannelContactAutoCreationPolicy
excludePrivateEvents: Boolean
isContactAutoCreationEnabled: Boolean
isSyncEnabled: Boolean
visibility: CalendarChannelVisibility
}
input UpdateCommandMenuItemInput {
availabilityObjectMetadataId: UUID
availabilityType: CommandMenuItemAvailabilityType
engineComponentKey: EngineComponentKey
hotKeys: [String!]
icon: String
id: UUID!
isPinned: Boolean
label: String
pageLayoutId: UUID
position: Float
shortLabel: String
}
input UpdateEmailGroupChannelInput {
displayName: String
id: UUID!
}
input UpdateFieldInput {
defaultValue: JSON
description: String
icon: String
isActive: Boolean
isAuditLogged: Boolean
isLabelSyncedWithName: Boolean
isNullable: Boolean
isSearchable: Boolean
isSystem: Boolean
isUIEditable: Boolean
isUIReadOnly: Boolean
isUnique: Boolean
label: String
morphRelationsUpdatePayload: [JSON!]
name: String
objectMetadataId: UUID
options: JSON
settings: JSON
translations: [MetadataTranslationOverrideInput!]
universalIdentifier: String
}
input UpdateFrontComponentInput {
"""The id of the front component to update"""
id: UUID!
"""The front component fields to update"""
update: UpdateFrontComponentInputUpdates!
}
input UpdateFrontComponentInputUpdates {
description: String
name: String
}
input UpdateGettingStartedInput {
completedStepActionKey: GettingStartedStepActionKey
isHidden: Boolean
selectedStepActionKey: GettingStartedStepActionKey
snoozedUntil: String
}
input UpdateLabPublicFeatureFlagInput {
publicFeatureFlag: String!
value: Boolean!
}
input UpdateLogicFunctionFromSourceInput {
"""Id of the logic function to update"""
id: UUID!
"""The logic function updates"""
update: UpdateLogicFunctionFromSourceInputUpdates!
}
input UpdateLogicFunctionFromSourceInputUpdates {
cronTriggerSettings: JSON
databaseEventTriggerSettings: JSON
description: String
handlerName: String
httpRouteTriggerSettings: JSON
name: String
sourceHandlerCode: String
sourceHandlerPath: String
timeoutSeconds: Float
toolTriggerSettings: JSON
workflowActionTriggerSettings: JSON
}
input UpdateMcpServerInput {
id: UUID!
update: UpdateMcpServerInputUpdates!
}
input UpdateMcpServerInputUpdates {
connectionProviderId: UUID
isActive: Boolean
label: String
name: String
url: String
}
input UpdateMessageChannelInput {
id: UUID!
update: UpdateMessageChannelInputUpdates!
}
input UpdateMessageChannelInputUpdates {
contactAutoCreationPolicy: MessageChannelContactAutoCreationPolicy
excludeGroupEmails: Boolean
excludeNonProfessionalEmails: Boolean
isContactAutoCreationEnabled: Boolean
isSyncEnabled: Boolean
messageFolderImportPolicy: MessageFolderImportPolicy
visibility: MessageChannelVisibility
}
input UpdateMessageFolderInput {
id: UUID!
update: UpdateMessageFolderInputUpdates!
}
input UpdateMessageFolderInputUpdates {
isSynced: Boolean!
}
input UpdateMessageFoldersInput {
ids: [UUID!]!
update: UpdateMessageFolderInputUpdates!
}
input UpdateNavigationMenuItemInput {
color: String
folderId: UUID
icon: String
link: String
name: String
pageLayoutId: UUID
position: Float
}
input UpdateObjectPayload {
color: String
description: String
icon: String
imageIdentifierFieldMetadataId: UUID
isActive: Boolean
isLabelSyncedWithName: Boolean
isSearchable: Boolean
labelIdentifierFieldMetadataId: UUID
labelPlural: String
labelSingular: String
namePlural: String
nameSingular: String
openRecordIn: ObjectOpenRecordIn
shortcut: String
translations: [MetadataTranslationOverrideInput!]
}
input UpdateOneFieldMetadataInput {
"""The id of the record to update"""
id: UUID!
"""The record to update"""
update: UpdateFieldInput!
}
input UpdateOneNavigationMenuItemInput {
"""The id of the record to update"""
id: UUID!
"""The record to update"""
update: UpdateNavigationMenuItemInput!
}
input UpdateOneObjectInput {
"""The id of the object to update"""
id: UUID!
update: UpdateObjectPayload!
}
input UpdatePageLayoutInput {
name: String
objectMetadataId: UUID
type: PageLayoutType
}
input UpdatePageLayoutTabInput {
icon: String
layoutMode: PageLayoutTabLayoutMode
position: Float
title: String
}
input UpdatePageLayoutTabWithWidgetsInput {
icon: String
id: UUID!
layoutMode: PageLayoutTabLayoutMode = GRID
position: Float!
title: String!
widgets: [UpdatePageLayoutWidgetWithIdInput!]!
}
input UpdatePageLayoutWidgetInput {
conditionalAvailabilityExpression: String
conditionalDisplay: JSON
configuration: JSON
isActive: Boolean
objectMetadataId: UUID
pageLayoutTabId: UUID
position: JSON
title: String
type: WidgetType
}
input UpdatePageLayoutWidgetWithIdInput {
conditionalAvailabilityExpression: String
conditionalDisplay: JSON
configuration: JSON
id: UUID!
objectMetadataId: UUID
pageLayoutTabId: UUID!
position: JSON
title: String!
type: WidgetType!
}
input UpdatePageLayoutWithTabsInput {
isFirstTabPinned: Boolean
name: String!
objectMetadataId: UUID
tabs: [UpdatePageLayoutTabWithWidgetsInput!]!
type: PageLayoutType!
}
input UpdateRoleInput {
"""The id of the role to update"""
id: UUID!
update: UpdateRolePayload!
}
input UpdateRolePayload {
canAccessAllAgentChatChannels: Boolean
canAccessAllTools: Boolean
canBeAssignedToAgents: Boolean
canBeAssignedToApiKeys: Boolean
canBeAssignedToUsers: Boolean
canDestroyAllObjectRecords: Boolean
canReadAllObjectRecords: Boolean
canSoftDeleteAllObjectRecords: Boolean
canUpdateAllObjectRecords: Boolean
canUpdateAllSettings: Boolean
description: String
icon: String
label: String
}
input UpdateSkillInput {
content: String
description: String
icon: String
id: UUID!
isActive: Boolean
label: String
name: String
}
input UpdateTimelineActivityTypeInput {
icon: String
id: UUID!
isActive: Boolean
label: String
translations: [MetadataTranslationOverrideInput!]
}
input UpdateUnsubscribeTopicInput {
description: String
id: String!
name: String
visibility: UnsubscribeTopicVisibility
}
input UpdateUsageLimitInput {
id: UUID!
payload: CreateUsageLimitInput!
}
input UpdateValidationRuleInput {
id: UUID!
update: UpdateValidationRuleInputUpdates!
}
input UpdateValidationRuleInputUpdates {
description: String
errorFieldMetadataId: UUID
expression: String
icon: String
isActive: Boolean
message: String
name: String
}
input UpdateViewFieldGroupInput {
"""The id of the view field group to update"""
id: UUID!
"""The view field group to update"""
update: UpdateViewFieldGroupInputUpdates!
}
input UpdateViewFieldGroupInputUpdates {
deletedAt: String @deprecated(reason: "Ignored: view field groups are no longer soft-deleted. Use destroyViewFieldGroup instead.")
isVisible: Boolean
name: String
position: Float
}
input UpdateViewFieldInput {
"""The id of the view field to update"""
id: UUID!
"""The view field to update"""
update: UpdateViewFieldInputUpdates!
}
input UpdateViewFieldInputUpdates {
aggregateOperation: AggregateOperations
isVisible: Boolean
position: Float
size: Float
viewFieldGroupId: UUID
}
input UpdateViewFilterGroupInput {
id: UUID
logicalOperator: ViewFilterGroupLogicalOperator = AND
parentViewFilterGroupId: UUID
positionInViewFilterGroup: Float
viewId: UUID
}
input UpdateViewFilterInput {
"""The id of the view filter to update"""
id: UUID!
"""The view filter to update"""
update: UpdateViewFilterInputUpdates!
}
input UpdateViewFilterInputUpdates {
fieldMetadataId: UUID
operand: ViewFilterOperand
positionInViewFilterGroup: Float
relationTargetFieldMetadataId: UUID
subFieldName: String
value: JSON
viewFilterGroupId: UUID
}
input UpdateViewGroupInput {
"""The id of the view group to update"""
id: UUID!
"""The view group to update"""
update: UpdateViewGroupInputUpdates!
}
input UpdateViewGroupInputUpdates {
fieldMetadataId: UUID
fieldValue: String
isVisible: Boolean
position: Float
}
input UpdateViewInput {
anyFieldFilterValue: String
calendarEndFieldMetadataId: UUID
calendarFieldMetadataId: UUID
calendarLayout: ViewCalendarLayout
groupLoadLimit: Int
icon: String
id: UUID
isCompact: Boolean
kanbanAggregateOperation: AggregateOperations
kanbanAggregateOperationFieldMetadataId: UUID
kanbanColumnWidth: Int
mainGroupByFieldMetadataId: UUID
name: String
"""
Deprecated: Superseded by objectMetadata.openRecordIn and the workspace member preference; kept one release for API compatibility, no longer read by the frontend.
"""
openRecordIn: ViewOpenRecordIn
position: Float
shouldHideEmptyGroups: Boolean
translations: [MetadataTranslationOverrideInput!]
type: ViewType
visibility: ViewVisibility
}
input UpdateViewSortInput {
"""The id of the view sort to update"""
id: UUID!
"""The view sort to update"""
update: UpdateViewSortInputUpdates!
}
input UpdateViewSortInputUpdates {
direction: ViewSortDirection
subFieldName: String
}
input UpdateWebhookInput {
"""The id of the webhook to update"""
id: UUID!
"""The webhook fields to update"""
update: UpdateWebhookInputUpdates!
}
input UpdateWebhookInputUpdates {
description: String
operations: [String!]
roleId: UUID
secret: String
targetUrl: String
}
input UpdateWorkspaceAllowedEmbeddingOriginsInput {
operation: String!
origin: String!
}
input UpdateWorkspaceIframeMediaPermissionsInput {
camera: Boolean!
microphone: Boolean!
origin: String!
}
input UpdateWorkspaceInput {
aiAdditionalInstructions: String
aiAgentModelTier: AiModelTier
aiChatDirectMessageAssistantMode: AiChatAssistantMode
aiChatInboxAssistantMode: AiChatAssistantMode
aiChatModelTier: AiModelTier
aiEvaluationModelId: String
aiModelIdByTier: JSON
allowImpersonation: Boolean
customDomain: String
defaultRoleId: UUID
displayName: String
editableProfileFields: [String!]
eventLogRetentionDays: Float
inviteHash: String
isAutoModelSelectionEnabled: Boolean
isCampaignClickTrackingEnabled: Boolean
isCampaignOpenTrackingEnabled: Boolean
isGoogleAuthBypassEnabled: Boolean
isGoogleAuthEnabled: Boolean
isInternalMessagesImportEnabled: Boolean
isMicrosoftAuthBypassEnabled: Boolean
isMicrosoftAuthEnabled: Boolean
isPasswordAuthBypassEnabled: Boolean
isPasswordAuthEnabled: Boolean
isPublicInviteLinkEnabled: Boolean
isTwoFactorAuthenticationEnforced: Boolean
logo: String
subdomain: String
trashRetentionDays: Float
workspaceDiscoverability: WorkspaceDiscoverability
}
input UpdateWorkspaceMemberSettingsInput {
update: JSON!
workspaceMemberId: UUID!
}
"""The `Upload` scalar type represents a file upload."""
scalar Upload
input UpsertFieldPermissionsInput {
fieldPermissions: [FieldPermissionInput!]!
roleId: UUID!
}
input UpsertFieldsWidgetFieldInput {
"""
The id of the field metadata. Used to create a new view field when viewFieldId is not provided.
"""
fieldMetadataId: UUID
isVisible: Boolean!
position: Float!
"""The id of the view field. Required if fieldMetadataId is not provided."""
viewFieldId: UUID
}
input UpsertFieldsWidgetGroupInput {
fields: [UpsertFieldsWidgetFieldInput!]!
id: UUID!
isVisible: Boolean!
name: String!
position: Float!
}
input UpsertFieldsWidgetInput {
"""
The ungrouped fields to upsert. When provided, all existing groups are deleted and fields are detached from groups. Mutually exclusive with "groups".
"""
fields: [UpsertFieldsWidgetFieldInput!]
"""
The groups (with nested fields) to upsert. Mutually exclusive with "fields".
"""
groups: [UpsertFieldsWidgetGroupInput!]
"""The id of the fields widget whose groups and fields to upsert"""
widgetId: UUID!
}
input UpsertObjectPermissionsInput {
objectPermissions: [ObjectPermissionInput!]!
roleId: UUID!
}
input UpsertPermissionFlagsInput {
permissionFlagKeys: [String!]!
roleId: UUID!
}
input UpsertRowLevelPermissionPredicatesInput {
objectMetadataId: UUID!
predicateGroups: [RowLevelPermissionPredicateGroupInput!]!
predicates: [RowLevelPermissionPredicateInput!]!
roleId: UUID!
}
type UpsertRowLevelPermissionPredicatesResult {
predicateGroups: [RowLevelPermissionPredicateGroup!]!
predicates: [RowLevelPermissionPredicate!]!
}
input UpsertViewWidgetInput {
"""
View-level settings (layout type, group by, kanban and calendar settings) to apply to the widget view.
"""
view: UpsertViewWidgetViewSettingsInput
"""The view fields to upsert."""
viewFields: [UpsertViewWidgetViewFieldInput!]
"""The view filter groups to upsert."""
viewFilterGroups: [UpsertViewWidgetViewFilterGroupInput!]
"""The view filters to upsert."""
viewFilters: [UpsertViewWidgetViewFilterInput!]
"""The view sorts to upsert."""
viewSorts: [UpsertViewWidgetViewSortInput!]
"""The id of the view widget (page layout widget)."""
widgetId: UUID!
}
input UpsertViewWidgetViewFieldInput {
aggregateOperation: AggregateOperations
"""
The field metadata id. Used to create a new view field when viewFieldId is not provided.
"""
fieldMetadataId: UUID
isVisible: Boolean!
position: Float!
size: Float
"""The id of an existing view field to update."""
viewFieldId: UUID
}
input UpsertViewWidgetViewFilterGroupInput {
id: UUID
logicalOperator: ViewFilterGroupLogicalOperator = AND
parentViewFilterGroupId: UUID
positionInViewFilterGroup: Float
}
input UpsertViewWidgetViewFilterInput {
fieldMetadataId: UUID!
id: UUID
operand: ViewFilterOperand
positionInViewFilterGroup: Float
relationTargetFieldMetadataId: UUID
subFieldName: String
value: JSON!
viewFilterGroupId: UUID
}
input UpsertViewWidgetViewSettingsInput {
calendarEndFieldMetadataId: UUID
calendarFieldMetadataId: UUID
calendarLayout: ViewCalendarLayout
kanbanAggregateOperation: AggregateOperations
kanbanAggregateOperationFieldMetadataId: UUID
kanbanColumnWidth: Int
mainGroupByFieldMetadataId: UUID
"""
Deprecated: Superseded by objectMetadata.openRecordIn and the workspace member preference; kept one release for API compatibility, no longer read by the frontend.
"""
openRecordIn: ViewOpenRecordIn
shouldHideEmptyGroups: Boolean
"""
The layout type of the widget view. Only widget view types (TABLE_WIDGET, KANBAN_WIDGET, LIST_WIDGET, CALENDAR_WIDGET) are allowed.
"""
type: ViewType
}
input UpsertViewWidgetViewSortInput {
direction: ViewSortDirection = ASC
fieldMetadataId: UUID!
id: UUID
}
type UsageAnalytics {
periodEnd: DateTime!
periodStart: DateTime!
timeSeries: [UsageTimeSeries!]!
usageByApplication: [UsageBreakdownItem!]!
usageByModel: [UsageBreakdownItem!]!
usageByOperationType: [UsageBreakdownItem!]!
usageByUser: [UsageBreakdownItem!]!
userDailyUsage: UsageUserDaily
}
input UsageAnalyticsInput {
operationTypes: [UsageOperationType!]
periodEnd: DateTime
periodStart: DateTime
userWorkspaceId: String
}
type UsageBreakdownItem {
creditsUsed: Float!
key: String!
label: String
userCreditsUsed: Float!
workspaceCreditsUsed: Float!
}
type UsageLimit {
burstValue: BigInt
createdAt: DateTime!
id: UUID!
limitKind: String!
limitValue: BigInt!
operationType: UsageOperationType!
periodCount: Int!
periodUnit: String!
resourceType: UsageResourceType!
spenderId: String
spenderType: String!
unit: UsageUnit!
updatedAt: DateTime!
}
type UsageLimitOperationDefinition {
allowedUnits: [UsageUnit!]!
operationType: UsageOperationType!
}
enum UsageOperationType {
AI_CHAT_TOKEN
AI_WORKFLOW_TOKEN
AI_WORKFLOW_WEB_SEARCH
ALL
API_REQUEST
APP_OPERATION
CALL_RECORDING
CODE_EXECUTION
EMAIL_SEND
MESSAGE_CAMPAIGN_SEND
RECORD_WRITE
STORAGE_FILE
SUBSCRIPTION
WEBHOOK_CALL
WEB_SEARCH
WORKFLOW_EXECUTION
}
type UsageQuotaDefinition {
allowedOperations: [UsageLimitOperationDefinition!]!
allowedSpenderTypes: [String!]!
limitKind: String!
operatorOnlyScopes: [UsageQuotaOperatorOnlyScope!]!
resourceType: UsageResourceType!
}
type UsageQuotaDefinitions {
definitions: [UsageQuotaDefinition!]!
hasAllowancePeriod: Boolean!
isIntraWorkspaceLimitEntitled: Boolean!
}
type UsageQuotaOperatorOnlyScope {
operationType: UsageOperationType!
periodUnit: String!
spenderType: String!
unit: UsageUnit!
}
type UsageQuotaScopeConsumption {
consumedValue: BigInt
periodEnd: DateTime!
periodStart: DateTime!
}
input UsageQuotaScopeInput {
operationType: UsageOperationType!
periodUnit: String!
resourceType: UsageResourceType!
spenderId: String
spenderType: String!
unit: UsageUnit!
}
type UsageQuotaWithConsumption {
consumedValue: BigInt
id: UUID!
isEnforced: Boolean!
limitValue: BigInt!
operationType: UsageOperationType!
periodEnd: DateTime
periodStart: DateTime
periodUnit: String!
remainingValue: BigInt
resourceType: UsageResourceType!
spenderId: String
spenderLabel: String
spenderType: String!
unit: UsageUnit!
}
enum UsageResourceType {
AI
ALL
API
APP
EMAIL
LOGIC_FUNCTION
RECORD
STORAGE
WEBHOOK
WORKFLOW
}
type UsageTimeSeries {
creditsUsed: Float!
date: String!
workspaceCreditsUsed: Float!
}
enum UsageUnit {
BYTE
COMPLEXITY
CREDIT
FILE
INVOCATION
MILLISECOND
MINUTE
RECORD
REQUEST
SEAT
TOKEN
USER_CREDIT
}
type UsageUserDaily {
dailyUsage: [UsageTimeSeries!]!
userWorkspaceId: String!
}
type User {
availableWorkspaces: AvailableWorkspaces!
canAccessFullAdminPanel: Boolean!
canImpersonate: Boolean!
createdAt: DateTime!
currentUserWorkspace: UserWorkspace
currentWorkspace: Workspace
deletedAt: DateTime
deletedWorkspaceMembers: [DeletedWorkspaceMember!]
disabled: Boolean
email: String!
firstName: String!
hasPassword: Boolean!
id: UUID!
isEmailVerified: Boolean!
isWorkspaceCreator: Boolean
lastName: String!
locale: String!
onboardingStatus: OnboardingStatus
previousOnboardingStatus: OnboardingStatus
supportUserHash: String
updatedAt: DateTime!
userVars: JSONObject
userWorkspaces: [UserWorkspace!]!
workspaceMember: WorkspaceMember
workspaceMembers: [WorkspaceMember!]
workspaces: [UserWorkspace!]!
}
type UserApplicationVariableValue {
description: String!
isDeprecated: Boolean!
isRequired: Boolean!
isSecret: Boolean!
key: String!
label: String!
options: JSON
type: String!
value: String!
}
enum UserCreditsFallback {
STOP
WORKSPACE_CREDITS
}
type UserSession {
authProvider: String!
city: String
country: String
createdAt: DateTime!
expiresAt: DateTime!
id: UUID!
ipAddress: String
isCurrent: Boolean!
isImpersonating: Boolean!
lastActiveAt: DateTime!
region: String
userAgent: String
workspaceId: UUID
}
type UserWorkspace {
createdAt: DateTime!
deletedAt: DateTime
id: UUID!
isImpersonating: Boolean
locale: String!
objectPermissions: [ObjectPermission!]
objectsPermissions: [ObjectPermission!]
permissionFlags: [PermissionFlagType!]
twoFactorAuthenticationMethodSummary: [TwoFactorAuthenticationMethodSummary!]
updatedAt: DateTime!
user: User!
userId: UUID!
}
input ValidateApprovedAccessDomainInput {
approvedAccessDomainId: UUID!
validationToken: String!
}
type ValidatePasswordResetToken {
email: String!
hasPassword: Boolean!
id: UUID!
}
type ValidationRule {
description: String
errorFieldMetadataId: UUID
expression: String!
icon: String
id: UUID!
isActive: Boolean!
message: String!
name: String!
objectMetadataId: UUID!
}
type VerificationRecord {
key: String!
priority: Float
status: String
type: String!
value: String!
}
type VerifyEmailAndGetLoginToken {
loginToken: AuthToken!
workspaceUrls: WorkspaceUrls!
}
type VerifyTwoFactorAuthenticationMethod {
success: Boolean!
}
type VersionDistributionEntry {
count: Int!
version: String!
}
type View {
anyFieldFilterValue: String
applicationId: UUID!
calendarEndFieldMetadataId: UUID
calendarFieldMetadataId: UUID
calendarLayout: ViewCalendarLayout
createdAt: DateTime!
createdByUserWorkspaceId: UUID
deletedAt: DateTime
groupLoadLimit: Int
icon: String!
id: UUID!
isActive: Boolean!
isCompact: Boolean!
isCustom: Boolean! @deprecated(reason: "Derived from applicationId and removed in 2.54: compare applicationId with the workspace custom application instead.")
isSystemSideEffect: Boolean!
kanbanAggregateOperation: AggregateOperations
kanbanAggregateOperationFieldMetadataId: UUID
kanbanColumnWidth: Int
key: ViewKey
mainGroupByFieldMetadataId: UUID
name: String!
objectMetadataId: UUID!
openRecordIn: ViewOpenRecordIn! @deprecated(reason: "Superseded by objectMetadata.openRecordIn and the workspace member preference; kept one release for API compatibility, no longer read by the frontend.")
position: Float!
shouldHideEmptyGroups: Boolean!
type: ViewType!
universalIdentifier: UUID!
updatedAt: DateTime!
viewFieldGroups: [ViewFieldGroup!]!
viewFields: [ViewField!]!
viewFilterGroups: [ViewFilterGroup!]!
viewFilters: [ViewFilter!]!
viewGroups: [ViewGroup!]!
viewSorts: [ViewSort!]!
visibility: ViewVisibility!
workspaceId: UUID!
}
enum ViewCalendarLayout {
DAY
MONTH
WEEK
}
type ViewConfiguration {
configurationType: WidgetConfigurationType!
}
type ViewField {
aggregateOperation: AggregateOperations
applicationId: UUID!
createdAt: DateTime!
deletedAt: DateTime
fieldMetadataId: UUID!
id: UUID!
isActive: Boolean!
isOverridden: Boolean @deprecated(reason: "isOverridden is deprecated")
isSystemSideEffect: Boolean!
isVisible: Boolean!
position: Float!
size: Float!
universalIdentifier: UUID!
updatedAt: DateTime!
viewFieldGroupId: UUID
viewId: UUID!
workspaceId: UUID!
}
type ViewFieldGroup {
createdAt: DateTime!
deletedAt: DateTime
id: UUID!
isActive: Boolean!
isOverridden: Boolean! @deprecated(reason: "isOverridden is deprecated")
isVisible: Boolean!
name: String!
position: Float!
updatedAt: DateTime!
viewFields: [ViewField!]!
viewId: UUID!
workspaceId: UUID!
}
type ViewFilter {
createdAt: DateTime!
deletedAt: DateTime
fieldMetadataId: UUID!
id: UUID!
operand: ViewFilterOperand!
positionInViewFilterGroup: Float
relationTargetFieldMetadataId: UUID
subFieldName: String
updatedAt: DateTime!
value: JSON!
viewFilterGroupId: UUID
viewId: UUID!
workspaceId: UUID!
}
type ViewFilterGroup {
createdAt: DateTime!
deletedAt: DateTime
id: UUID!
logicalOperator: ViewFilterGroupLogicalOperator!
parentViewFilterGroupId: UUID
positionInViewFilterGroup: Float
updatedAt: DateTime!
viewId: UUID!
workspaceId: UUID!
}
enum ViewFilterGroupLogicalOperator {
AND
NOT
OR
}
enum ViewFilterOperand {
CONTAINS
DOES_NOT_CONTAIN
GREATER_THAN_OR_EQUAL
IS
IS_AFTER
IS_BEFORE
IS_EMPTY
IS_IN_FUTURE
IS_IN_PAST
IS_NOT
IS_NOT_EMPTY
IS_NOT_NULL
IS_RELATIVE
IS_TODAY
LESS_THAN_OR_EQUAL
VECTOR_SEARCH
}
type ViewGroup {
createdAt: DateTime!
deletedAt: DateTime
fieldValue: String!
id: UUID!
isVisible: Boolean!
position: Float!
updatedAt: DateTime!
viewId: UUID!
workspaceId: UUID!
}
enum ViewKey {
INDEX
}
enum ViewOpenRecordIn {
RECORD_PAGE
SIDE_PANEL
}
type ViewSort {
createdAt: DateTime!
deletedAt: DateTime
direction: ViewSortDirection!
fieldMetadataId: UUID!
id: UUID!
subFieldName: String
updatedAt: DateTime!
viewId: UUID!
workspaceId: UUID!
}
enum ViewSortDirection {
ASC
DESC
}
enum ViewType {
CALENDAR
CALENDAR_WIDGET
FIELDS_WIDGET
KANBAN
KANBAN_WIDGET
LIST
LIST_WIDGET
TABLE
TABLE_WIDGET
}
enum ViewVisibility {
UNLISTED
WORKSPACE
}
type Webhook {
applicationId: UUID!
createdAt: DateTime!
deletedAt: DateTime
description: String
id: UUID!
operations: [String!]!
role: Role
secret: String!
targetUrl: String!
updatedAt: DateTime!
}
union WidgetConfiguration = AggregateChartConfiguration | BarChartConfiguration | CalendarConfiguration | CallRecordingSummaryConfiguration | CallRecordingTranscriptConfiguration | ChatConfiguration | ChatThreadsConfiguration | EmailThreadConfiguration | EmailsConfiguration | FieldConfiguration | FieldRichTextConfiguration | FieldsConfiguration | FilesConfiguration | FormFieldConfiguration | FrontComponentConfiguration | IframeConfiguration | LineChartConfiguration | MessageCampaignBodyConfiguration | MessageCampaignDetailsConfiguration | NotesConfiguration | PieChartConfiguration | RecordTableConfiguration | StandaloneRichTextConfiguration | TasksConfiguration | TimelineConfiguration | ViewConfiguration | WorkflowConfiguration | WorkflowRunConfiguration | WorkflowVersionConfiguration
enum WidgetConfigurationType {
AGGREGATE_CHART
BAR_CHART
CALENDAR
CALL_RECORDING_SUMMARY
CALL_RECORDING_TRANSCRIPT
CHAT
CHAT_THREADS
EMAILS
EMAIL_THREAD
FIELD
FIELDS
FIELD_RICH_TEXT
FILES
FORM_FIELD
FRONT_COMPONENT
IFRAME
LINE_CHART
MESSAGE_CAMPAIGN_BODY
MESSAGE_CAMPAIGN_DETAILS
NOTES
PIE_CHART
RECORD_TABLE
STANDALONE_RICH_TEXT
TASKS
TIMELINE
VIEW
WORKFLOW
WORKFLOW_RUN
WORKFLOW_VERSION
}
enum WidgetType {
CALENDAR
CALL_RECORDING_SUMMARY
CALL_RECORDING_TRANSCRIPT
CHAT
CHAT_THREADS
EMAILS
EMAIL_THREAD
FIELD
FIELDS
FIELD_RICH_TEXT
FILES
FORM_FIELD
FRONT_COMPONENT
GRAPH
IFRAME
MESSAGE_CAMPAIGN_BODY
MESSAGE_CAMPAIGN_DETAILS
NOTES
RECORD_TABLE
STANDALONE_RICH_TEXT
TASKS
TIMELINE
VIEW
WORKFLOW
WORKFLOW_RUN
WORKFLOW_VERSION
}
enum WorkflowActionType {
AI_AGENT
CLASSIFY
CODE
CREATE_CALENDAR_EVENT
CREATE_RECORD
DELAY
DELETE_RECORD
DRAFT_EMAIL
EMPTY
FILTER
FIND_RECORDS
FORM
HTTP_REQUEST
IF_ELSE
ITERATOR
LOGIC_FUNCTION
PICK_RECORD
SEND_CHAT_MESSAGE
SEND_EMAIL
UPDATE_RECORD
UPSERT_RECORD
WAIT_FOR_EVENT
}
type WorkflowConfiguration {
configurationType: WidgetConfigurationType!
}
type WorkflowRunConfiguration {
configurationType: WidgetConfigurationType!
}
type WorkflowVersionConfiguration {
configurationType: WidgetConfigurationType!
}
type Workspace {
activationStatus: WorkspaceActivationStatus!
aiAdditionalInstructions: String
aiAgentModelTier: AiModelTier!
aiChatDirectMessageAssistantMode: AiChatAssistantMode!
aiChatInboxAssistantMode: AiChatAssistantMode!
aiChatModelTier: AiModelTier!
aiEvaluationModelId: String
aiModelIdByTier: JSON!
allowImpersonation: Boolean!
allowedEmbeddingOrigins: [String!]
billingCustomer: BillingCustomer
billingEntitlements: [BillingEntitlement!]!
billingSubscriptions: [BillingSubscription!]!
createdAt: DateTime!
currentBillingSubscription: BillingSubscription
customDomain: String
databaseSchema: String
defaultRole: Role
deletedAt: DateTime
displayName: String
editableProfileFields: [String!]
eventLogRetentionDays: Float!
featureFlags: [FeatureFlag!]
hasValidEnterpriseValidityToken: Boolean!
hasValidSignedEnterpriseKey: Boolean!
id: UUID!
iframeMediaPermissions: [IframeMediaPermission!]
installedApplications: [Application!]!
inviteHash: String
isAutoModelSelectionEnabled: Boolean!
isCampaignClickTrackingEnabled: Boolean!
isCampaignOpenTrackingEnabled: Boolean!
isCustomDomainEnabled: Boolean!
isGoogleAuthBypassEnabled: Boolean!
isGoogleAuthEnabled: Boolean!
isInternalMessagesImportEnabled: Boolean!
isMicrosoftAuthBypassEnabled: Boolean!
isMicrosoftAuthEnabled: Boolean!
isPasswordAuthBypassEnabled: Boolean!
isPasswordAuthEnabled: Boolean!
isPublicInviteLinkEnabled: Boolean!
isTrialAvailable: Boolean!
isTwoFactorAuthenticationEnforced: Boolean!
logo: String
logoFileId: UUID
metadataVersion: Float! @deprecated(reason: "No longer used for metadata cache invalidation, will be removed")
subdomain: String!
trashRetentionDays: Float!
updatedAt: DateTime!
viewFields: [ViewField!]
viewFilterGroups: [ViewFilterGroup!]
viewFilters: [ViewFilter!]
viewGroups: [ViewGroup!]
viewSorts: [ViewSort!]
views: [View!]
workspaceCustomApplication: Application
workspaceCustomApplicationId: String!
workspaceDiscoverability: WorkspaceDiscoverability!
workspaceMembersCount: Float
workspaceUrls: WorkspaceUrls!
}
enum WorkspaceActivationStatus {
ACTIVE
CREATED
INACTIVE
ONGOING_CREATION
PENDING_CREATION
SUSPENDED
}
type WorkspaceAiStats {
conversationsCount: Int!
skillsCount: Int!
toolsCount: Int!
}
enum WorkspaceCompanyEnrichmentOutcome {
matched
transientError
unavailable
}
type WorkspaceCompanyEnrichmentResult {
enrichment: JSON
isBookCallOnboardingStepPending: Boolean!
outcome: WorkspaceCompanyEnrichmentOutcome!
personEnrichment: JSON
personOutcome: WorkspacePersonEnrichmentOutcome!
}
type WorkspaceCreationDefaultsDTO {
displayName: String!
subdomain: String!
}
enum WorkspaceDiscoverability {
HIDDEN
MEMBERS_AND_INVITEES
PUBLIC
}
type WorkspaceInvitation {
email: String!
expiresAt: DateTime!
id: UUID!
roleId: UUID
}
type WorkspaceInviteHashValid {
isValid: Boolean!
}
type WorkspaceMember {
avatarUrl: String
calendarStartDay: Int
colorScheme: String!
dateFormat: WorkspaceMemberDateFormatEnum
id: UUID!
locale: String
name: FullName!
numberFormat: WorkspaceMemberNumberFormatEnum
openRecordIn: OpenRecordIn!
roles: [Role!]
timeFormat: WorkspaceMemberTimeFormatEnum
timeZone: String
uiScale: String!
userEmail: String!
userId: UUID!
userWorkspaceId: UUID
}
type WorkspaceMemberApplicationVariables {
userWorkspaceId: UUID!
variables: [UserApplicationVariableValue!]!
workspaceMemberId: UUID!
}
"""Date format as Month first, Day first, Year first or system as default"""
enum WorkspaceMemberDateFormatEnum {
DAY_FIRST
MONTH_FIRST
SYSTEM
YEAR_FIRST
}
"""Number format for displaying numbers"""
enum WorkspaceMemberNumberFormatEnum {
APOSTROPHE_AND_DOT
COMMAS_AND_DOT
DOTS_AND_COMMA
SPACES_AND_COMMA
SYSTEM
}
"""Time time as Military, Standard or system as default"""
enum WorkspaceMemberTimeFormatEnum {
HOUR_12
HOUR_24
SYSTEM
}
type WorkspaceMigration {
actions: JSON!
applicationUniversalIdentifier: String!
}
type WorkspaceNameAndId {
displayName: String
id: UUID!
}
enum WorkspacePersonEnrichmentOutcome {
matched
transientError
unavailable
}
enum WorkspaceSetupChatOutcome {
ALREADY_STARTED
STARTED
UNAVAILABLE
}
type WorkspaceUrls {
customUrl: String
subdomainUrl: String!
}
type WorkspaceUrlsAndId {
id: UUID!
workspaceUrls: WorkspaceUrls!
}