Integrations

Direct integration installations and synchronization state.

Last updated August 10, 2026

Queries

directIntegrationInstallation query

Returns the direct-integration installation with the given id.

directIntegrationInstallation(id: ID!): DirectIntegrationInstallation

Returns: DirectIntegrationInstallation

Arguments for directIntegrationInstallation

Name	Description
`id` (`ID!`)

directIntegrationInstallations query

Returns the direct-integration installations.

directIntegrationInstallations(first: Int, after: String, last: Int, before: String, where: DirectIntegrationInstallationFilterInput, order: [DirectIntegrationInstallationSortInput!]): DirectIntegrationInstallationsConnection

Returns: DirectIntegrationInstallationsConnection

Arguments for directIntegrationInstallations

Name	Description
`where` (DirectIntegrationInstallationFilterInput)
`order` ([DirectIntegrationInstallationSortInput!])
`first` (`Int`)	Returns the first n elements from the list.
`after` (`String`)	Returns elements after the specified cursor.
`last` (`Int`)	Returns the last n elements from the list.
`before` (`String`)	Returns elements before the specified cursor.

Objects

AdIntegrationDataAccess object

Fields returned by the AdIntegrationDataAccess object type.

Name	Description
`installed` (`Boolean!`)
`groups` (`Boolean!`)

AssignLicenseActionMetadata object

Fields returned by the AssignLicenseActionMetadata object type.

Name	Description
`plansSelection` (PlansSelection!)
`userShouldExist` (`Boolean!`)
`customInputs` ([CustomInputMetadata!]!)

ConnectedDirectIntegrationInstallationStatus object

The installation is connected.

Name	Description
`connectedAt` (DateTime!)	When the installation was connected.

CustomerSetting object

Fields returned by the CustomerSetting object type.

Name	Description
`name` (`String!`)
`description` (`String!`)
`formType` (CustomerSettingFormType!)
`validationStrategies` (`[String!]!`)
`initialValues` (`[String!]!`)
`required` (`Boolean!`)
`sensitive` (`Boolean!`)

CustomInputMetadata object

Fields returned by the CustomInputMetadata object type.

Name	Description
`key` (`String!`)
`name` (`String!`)
`description` (`String!`)
`type` (CustomInputType!)
`required` (`Boolean!`)

DirectIntegration object

Fields returned by the DirectIntegration object type.

Name	Description
`id` (UUID!)
`objectId` (`ID!`)
`name` (`String!`)
`status` (DirectIntegrationStatus!)
`helpUrl` (URL)
`vendorId` (`ID`)
`categories` (`[String!]!`)
`features` (`[String!]!`)
`description` (`String!`)
`htmlDescription` (`String!`)
`applicationId` (`ID`)
`customerSettings` ([CustomerSetting!])
`installations` (InstallationsConnection)
`recommended` (`Boolean!`)
`authorization` (BaseAuthorizationConfiguration!)
`popupAuthorization` (PopupAuthorizationOptions)
`integrationCustomInputs` ([CustomInputMetadata!]!)
`application` (Application)
`vendor` (Vendor)

DirectIntegrationEntitySyncResult object

The synchronization result for one entity.

Name	Description
`entity` (`String!`)	The synchronized entity.
`count` (`Int!`)	The number of synchronized items.

DirectIntegrationExternalApiRequest object

A request sent to the integrated service.

Name	Description
`url` (`String!`)	The requested URL.

DirectIntegrationExternalApiResponse object

An error response received from the integrated service.

Name	Description
`message` (`String`)	The error message.
`statusCode` (`Int!`)	The HTTP status code of the response.
`reasonPhrase` (`String`)	The HTTP reason phrase of the response.

DirectIntegrationInstallation object

An installation of a direct integration.

Name	Description
`id` (`ID!`)	The installation id.
`createdAt` (DateTime!)	When the installation was connected.
`integratedByUserId` (`ID!`)	The id of the user who connected the installation.
`name` (`String!`)	The installation name.
`installationStatus` (DirectIntegrationInstallationStatus!)	The current status of the installation.
`syncMetrics` (DirectIntegrationSyncMetrics!)	The installation's data synchronization metrics.
`integration` (DirectIntegration)	The direct integration this installation belongs to.
`integratedBy` (User)

DirectIntegrationInstallationsConnection object

A connection to a list of items.

Name	Description
`pageInfo` (PageInfo!)	Information to aid in pagination.
`edges` ([DirectIntegrationInstallationsEdge!])	A list of edges.
`nodes` ([DirectIntegrationInstallation!])	A flattened list of the nodes.
`totalCount` (`Int!`)	Identifies the total count of items in the connection.

DirectIntegrationInstallationsEdge object

An edge in a connection.

Name	Description
`cursor` (`String!`)	A cursor for use in pagination.
`node` (DirectIntegrationInstallation!)	The item at the end of the edge.

DirectIntegrationSyncMetrics object

The installation's data synchronization metrics.

Name	Description
`lastRun` (DateTime)	When the last synchronization ran.
`lastSuccessfulRun` (DateTime)	When the last successful synchronization ran.
`fetching` (`Boolean!`)	Whether a synchronization is currently running.
`entitySyncResults` ([DirectIntegrationEntitySyncResult!])	The synchronization results per entity.

DisconnectedDirectIntegrationInstallationStatus object

The installation is disconnected.

Name	Description
`reason` (`String!`)	Why the installation was disconnected.
`disconnectedAt` (DateTime!)	When the installation was disconnected.

FetchedInterval object

Fields returned by the FetchedInterval object type.

Name	Description
`from` (Date!)
`to` (Date!)

InstallationsConnection object

A connection to a list of items.

Name	Description
`pageInfo` (PageInfo!)	Information to aid in pagination.
`edges` ([InstallationsEdge!])	A list of edges.
`nodes` ([DirectIntegrationInstallation!])	A flattened list of the nodes.
`totalCount` (`Int!`)	Identifies the total count of items in the connection.

InstallationsEdge object

An edge in a connection.

Name	Description
`cursor` (`String!`)	A cursor for use in pagination.
`node` (DirectIntegrationInstallation!)	The item at the end of the edge.

Integration object

Fields returned by the Integration object type.

Name	Description
`id` (`ID!`)
`createdAt` (DateTime!)
`integratedByUserId` (`ID!`)
`name` (`String!`)
`templateId` (UUID!)
`interval` (FetchedInterval)
`customSettings` ([IntegrationCustomSetting!])
`actionAvailability` ([IActionAvailabilityResult!]!)
`actions` ([IntegrationAction!]!)
`categories` (`[String!]!`)
`template` (DirectIntegration)
`integratedBy` (User)

IntegrationAction object

Fields returned by the IntegrationAction object type.

Name	Description
`actionName` (`String!`)
`availability` (IActionAvailabilityResult!)
`metadata` (ActionMetadata)

IntegrationCustomSetting object

Fields returned by the IntegrationCustomSetting object type.

Name	Description
`single` (IntegrationCustomSettingSingle)
`multiple` (IntegrationCustomSettingMultiple)

IntegrationCustomSettingMultiple object

Fields returned by the IntegrationCustomSettingMultiple object type.

Name	Description
`inputKey` (`String!`)
`values` ([IntegrationCustomSettingValue!]!)

IntegrationCustomSettingSingle object

Fields returned by the IntegrationCustomSettingSingle object type.

Name	Description
`inputKey` (`String!`)
`value` (IntegrationCustomSettingValue!)

IntegrationCustomSettingValue object

Fields returned by the IntegrationCustomSettingValue object type.

Name	Description
`key` (`String!`)
`value` (`String!`)

LimitedPlansSelection object

Fields returned by the LimitedPlansSelection object type.

Name	Description
`sourcePlanIds` (`[String!]!`)
`multiple` (`Boolean!`)

PopupAuthorizationOptions object

Fields returned by the PopupAuthorizationOptions object type.

Name	Description
`required` (`Boolean!`)
`popupUrl` (`String!`)
`redirectUrl` (`String!`)

PreselectedPlansSelection object

Fields returned by the PreselectedPlansSelection object type.

Name	Description
`sourcePlanIds` (`[String!]!`)
`additional` (`Boolean!`)

RemoveLicenseActionMetadata object

Fields returned by the RemoveLicenseActionMetadata object type.

Name	Description
`customInputs` ([CustomInputMetadata!]!)

SimplePlansSelection object

Fields returned by the SimplePlansSelection object type.

Name	Description
`multiple` (`Boolean!`)

UnderInvestigationDirectIntegrationInstallationStatus object

The installation reported errors and is under investigation.

Name	Description
`response` (DirectIntegrationExternalApiResponse)	The error response that triggered the investigation.
`request` (DirectIntegrationExternalApiRequest)	The request that caused the error response.

Input Types

ComparableObjectIdOperationFilterInput input

Input fields accepted by ComparableObjectIdOperationFilterInput.

Name	Description
`eq` (`ID`)
`neq` (`ID`)
`in` (`[ID!]`)
`nin` (`[ID!]`)
`gt` (`ID`)
`ngt` (`ID`)
`gte` (`ID`)
`ngte` (`ID`)
`lt` (`ID`)
`nlt` (`ID`)
`lte` (`ID`)
`nlte` (`ID`)

DirectIntegrationInstallationFilterInput input

An installation of a direct integration.

Name	Description
`and` ([DirectIntegrationInstallationFilterInput!])
`or` ([DirectIntegrationInstallationFilterInput!])
`id` (ComparableObjectIdOperationFilterInput)	The installation id.
`name` (queryable_StringOperationFilterInput)	The installation name.
`integration` (DirectIntegrationWithoutInstallationsFilterType)	The direct integration this installation belongs to.
`installationStatus` (queryable_DirectIntegrationInstallationStatusFilterInput)	The current status of the installation.

DirectIntegrationInstallationSortInput input

An installation of a direct integration.

Name	Description
`createdAt` (queryable_SortEnumType)	When the installation was connected.
`name` (queryable_SortEnumType)	The installation name.

DirectIntegrationWithoutInstallationsFilterType input

Input fields accepted by DirectIntegrationWithoutInstallationsFilterType.

Name	Description
`and` ([DirectIntegrationWithoutInstallationsFilterType!])
`or` ([DirectIntegrationWithoutInstallationsFilterType!])
`id` (ComparableObjectIdOperationFilterInput)
`name` (queryable_StringOperationFilterInput)
`vendorId` (ComparableObjectIdOperationFilterInput)
`applicationId` (ComparableObjectIdOperationFilterInput)
`categories` (ListStringOperationFilterInput)

queryable_DirectIntegrationInstallationStatusFilterInput input

Input fields accepted by queryable_DirectIntegrationInstallationStatusFilterInput.

Name	Description
`and` ([queryable_DirectIntegrationInstallationStatusFilterInput!])
`or` ([queryable_DirectIntegrationInstallationStatusFilterInput!])
`type` (queryable_DirectIntegrationInstallationStatusTypeOperationFilterInput)

queryable_DirectIntegrationInstallationStatusTypeOperationFilterInput input

Input fields accepted by queryable_DirectIntegrationInstallationStatusTypeOperationFilterInput.

Name	Description
`eq` (DirectIntegrationInstallationStatusType)
`neq` (DirectIntegrationInstallationStatusType)
`in` ([DirectIntegrationInstallationStatusType!])
`nin` ([DirectIntegrationInstallationStatusType!])

queryable_StringOperationFilterInput input

Input fields accepted by queryable_StringOperationFilterInput.

Name	Description
`and` ([queryable_StringOperationFilterInput!])
`or` ([queryable_StringOperationFilterInput!])
`eq` (`String`)
`neq` (`String`)
`contains` (`String`)
`ncontains` (`String`)
`in` (`[String]`)
`nin` (`[String]`)
`startsWith` (`String`)
`nstartsWith` (`String`)
`endsWith` (`String`)
`nendsWith` (`String`)

Interfaces

BaseAuthorizationConfiguration interface

Fields defined by the BaseAuthorizationConfiguration interface.

Name	Description
`type` (AuthorizationType!)

IActionAvailabilityResult interface

Fields defined by the IActionAvailabilityResult interface.

Name	Description
`actionName` (`String!`)
`isAvailable` (`Boolean!`)
`reason` (ActionUnAvailabilityReason)
`description` (`String`)

Unions

ActionMetadata union

Possible object types returned by the ActionMetadata union.

Possible types: AssignLicenseActionMetadata, RemoveLicenseActionMetadata

DirectIntegrationInstallationStatus union

Possible object types returned by the DirectIntegrationInstallationStatus union.

Possible types: DisconnectedDirectIntegrationInstallationStatus, UnderInvestigationDirectIntegrationInstallationStatus, ConnectedDirectIntegrationInstallationStatus

PlansSelection union

Possible object types returned by the PlansSelection union.

Possible types: SimplePlansSelection, LimitedPlansSelection, PreselectedPlansSelection

Enums

ActionUnAvailabilityReason enum

Accepted values for the ActionUnAvailabilityReason enum.

Value	Description
`NOT_IMPLEMENTED`
`NOT_SUPPORTED`
`CUSTOMER_SETTING_MISSED`
`TOKEN_PERMISSION_MISSED`

AuthorizationType enum

Accepted values for the AuthorizationType enum.

Value	Description
`NONE`
`CUSTOM`
`O_AUTH_PKCE`

CustomerSettingFormType enum

Accepted values for the CustomerSettingFormType enum.

Value	Description
`INPUT`
`DROP_DOWN`
`RICH_TEXT`

CustomInputType enum

Accepted values for the CustomInputType enum.

Value	Description
`TEXT_INPUT`
`DROP_DOWN`
`MULTI_SELECT`

DirectIntegrationInstallationStatusType enum

Accepted values for the DirectIntegrationInstallationStatusType enum.

Value	Description
`CONNECTED`
`DISCONNECTED`
`UNDER_INVESTIGATION`

DirectIntegrationStatus enum

Accepted values for the DirectIntegrationStatus enum.

Value	Description
`ACTIVE`
`BETA`
`ROADMAP`

queryable_SortEnumType enum

Accepted values for the queryable_SortEnumType enum.

Value	Description
`ASC`
`DESC`

Identity

The authenticated user's identity and permissions.

Licenses

Contracts, license plans, assigned licenses, analytics, usage, pricing, and optimization opportunities.