Skip to main content

integrations Query

Returns a Relay Connection to a collection of Integration objects.

Access is permitted when any of the following condition(s) are met: 1. The signed-in User has any of the following permissions for the associated Organization: [org_admin_integration_permissions, org_manage_integrations, org_view_integrations]. 2. The Customer User has any of the following permissions for the Customer and the Objects Attribute marketplace_configuration is AVAILABLE_AND_DEPLOYABLE OR AVAILABLE_NOT_DEPLOYABLE: [customer_admin_instance_deploy]. 3. The signed-in User has any of the following permissions for any version of the object: [integration_admin_permissions, integration_view, integration_edit, integration_remove]. 4. The signed-in User has any of the following permissions for the associated Customer of Integrations available in the Marketplace: [customer_manage_marketplace_integrations]. 5. The signed-in User has any of the following permissions for the associated Customer of Integrations available in the Marketplace: [customer_access_marketplace_integrations].

Input fields#

ArgumentTypeDescription
marketplaceBooleanReturns only the version of Integrations either deployed or available in the Marketplace
allVersionsBooleanReturn all versions instead of only the latest
hasInstancesBooleanReturn only Integrations that have Instances
beforeStringSpecifies a cursor for use in combination with last to implement backward pagination.
afterStringSpecifies a cursor for use in combination with first to implement forward pagination.
firstIntA non-negative integer that specifies to return at most first edges after the after cursor.
lastIntA non-negative integer that specifies to return at most last edges before the before cursor.
offsetInt
orderByIntegrationOrderDEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy[IntegrationOrder]Allows specifying many field and direction pairs to sort results by.
nameStringFilter for objects where name matches the specified value.
name_IcontainsStringFilter for objects where name contains the specified value (case insensitive).
descriptionStringFilter for objects where description matches the specified value.
description_IcontainsStringFilter for objects where description contains the specified value (case insensitive).
hasUnpublishedChangesBooleanFilter for objects where hasUnpublishedChanges matches the specified value.
categoryStringFilter for objects where category matches the specified value.
category_IcontainsStringFilter for objects where category contains the specified value (case insensitive).
marketplaceConfiguration_IstartswithStringFilter for objects where marketplaceConfiguration starts with the specified value (case insensitive).
marketplaceConfiguration_IexactStringFilter for objects where marketplaceConfiguration.iexact matches the specified value.
versionSequenceIdUUIDFilter for objects where versionSequenceId matches the specified value.
versionNumberIntFilter for objects where versionNumber matches the specified value.
versionIsAvailableBooleanFilter for objects where versionIsAvailable matches the specified value.
labels_IcontainsStringFilter for objects where labels contains the specified value (case insensitive).

Return fields (IntegrationConnection!)#

edges ([IntegrationEdge]!)#

List of edges containing the nodes in this connection.

nodes ([Integration]!)#

List of nodes in this connection.

pageInfo (PageInfo!)#

Pagination data for this connection.

totalCount (Int!)#

Total count of nodes available.