Queries

This page lists all available GraphQL query operations in alphabetical order.

action

Returns the specified Action object.

query {
  action(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the Action object.

Return fields (Action)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the Action.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the Action.
allowsBranching	Boolean!	Specifies whether the Action will allow Conditional Branching.
authorizationMethods	AuthorizationMethodConnection!	The AuthorizationMethods that are supported by the Action.
authorizationRequired	Boolean	Specifies whether the Action requires authorization to function.
breakLoop	Boolean	Specifies whether an Action will break out of a loop.
canCallComponentFunctions	Boolean!	Specifies whether the Action can call other Component Actions, Data Sources, or Triggers.
component	Component	The Component to which this Action is associated.
dataSourceType	ActionDataSourceType	Specifies the type of the resulting data from the data source.
description	String!	Additional notes about the Action.
detailDataSource	Action	The Data Source in this Component which can provide additional details about the content for this Data Source, such as example values when selecting particular API object fields.
directions	String	Notes which may provide insight on the intended use of the Action.
dynamicBranchInput	String!	A string that associates an Input with Dynamic Branching.
examplePayload	JSONString	An example of the returned payload of an Action.
hasOnInstanceDelete	Boolean!	Specifies whether the Action, if it is a Trigger, has an Instance Delete handler function defined.
hasOnInstanceDeploy	Boolean!	Specifies whether the Action, if it is a Trigger, has an Instance Deploy handler function defined.
hasWebhookCreateFunction	Boolean!	Specifies whether the Action, if it is a Trigger, has a webhook create handler function defined.
hasWebhookDeleteFunction	Boolean!	Specifies whether the Action, if it is a Trigger, has a webhook delete handler function defined.
id	ID!	The ID of the object
important	Boolean!	Specifies whether the Action is important and/or commonly used.
inputs	InputFieldConnection!	The Action to which this InputField is associated, if any.
isCommonTrigger	Boolean	Specifies whether the Action is a commonly used Trigger.
isDataSource	Boolean!	Specifies whether the Action is a Data Source.
isDetailDataSource	Boolean!	Specifies whether the Action is designed to be used as a detail data source.
isPollingTrigger	Boolean	Specifies whether the Action, if it is a Trigger, is a polling trigger.
isTrigger	Boolean!	Specifies whether the Action is a Trigger.
key	String!	A string that uniquely identifies this Action within the context of the Component.
label	String!	The name of the Action.
scheduleSupport	ActionScheduleSupport	Specifies support for triggering an Integration on a recurring schedule.
searchTerms	String	A combination of an action's text metadata to be used in search functionality.
staticBranchNames	[String!]	The static branch names associated with an Action.
synchronousResponseSupport	ActionSynchronousResponseSupport	Specifies support for synchronous responses to an Integration webhook request.
terminateExecution	Boolean!	Specifies whether the Action will terminate Instance execution.

---

actions

Returns a Relay Connection to a collection of Action objects.

query {
  actions {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
filterQuery	JSONString	JSON structure defining a conditional logic expression tree to use for including specific Actions.
includeForCodeNativeIntegrations	Boolean	Include Actions from Components associated with Code Native Integrations.
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
key	String	Filter for objects where key matches the specified value.
key_Icontains	String	Filter for objects where key contains the specified value (case insensitive).
key_In	[String]	Filter for objects where key is contained in the list of specified values.
label_Icontains	String	Filter for objects where label contains the specified value (case insensitive).
label_Fulltext	String	Filter for objects where label.fulltext matches the specified value.
description_Icontains	String	Filter for objects where description contains the specified value (case insensitive).
component	ID	Filter for objects where component matches the specified ID.
isTrigger	Boolean	Filter for objects where isTrigger matches the specified value.
isCommonTrigger	Boolean	Filter for objects where isCommonTrigger matches the specified value.
isPollingTrigger	Boolean	Filter for objects where isPollingTrigger matches the specified value.
isDataSource	Boolean	Filter for objects where isDataSource matches the specified value.
isDetailDataSource	Boolean	Filter for objects where isDetailDataSource matches the specified value.
dataSourceType	String	Filter for objects where dataSourceType matches the specified value.
hasOnInstanceDeploy	Boolean	Filter for objects where hasOnInstanceDeploy matches the specified value.
hasOnInstanceDelete	Boolean	Filter for objects where hasOnInstanceDelete matches the specified value.
hasWebhookCreateFunction	Boolean	Filter for objects where hasWebhookCreateFunction matches the specified value.
hasWebhookDeleteFunction	Boolean	Filter for objects where hasWebhookDeleteFunction matches the specified value.
searchTerms_Fulltext	String	Filter for objects where searchTerms.fulltext matches the specified value.
canCallComponentFunctions	Boolean	Filter for objects where canCallComponentFunctions matches the specified value.
orderBy	ActionOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[ActionOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (ActionConnection!)

Field	Type	Description
edges	[ActionEdge]!	List of edges containing the nodes in this connection.
nodes	[Action]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

activities

Returns a Relay Connection to a collection of Activity objects.

query {
  activities {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
description	String	Filter for objects where description matches the specified value.
description_Icontains	String	Filter for objects where description contains the specified value (case insensitive).
timestamp	DateTime	Filter for objects where timestamp matches the specified value.
timestamp_Gt	DateTime	Filter for objects where timestamp.gt matches the specified value.
timestamp_Lt	DateTime	Filter for objects where timestamp.lt matches the specified value.
timestamp_Gte	DateTime	Filter for objects where timestamp occurs on or after the specified value.
timestamp_Lte	DateTime	Filter for objects where timestamp occurs on or before the specified value.
user	ID	Filter for objects where user matches the specified ID.
orderBy	ActivityOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[ActivityOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (ActivityConnection!)

Field	Type	Description
edges	[ActivityEdge]!	List of edges containing the nodes in this connection.
nodes	[Activity]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

activity

Returns the specified Activity object.

query {
  activity(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the Activity object.

Return fields (Activity)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the Activity.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the Activity.
description	String!	Description of an activity performed by a user
id	ID!	The ID of the object
timestamp	DateTime!	Date/Time when an activity occurred
user	User	User that performed an activity
userName	String!	Name of the user that performed the activity

---

alertEvent

Returns the specified AlertEvent object.

query {
  alertEvent(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the AlertEvent object.

Return fields (AlertEvent)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the AlertEvent.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the AlertEvent.
createdAt	DateTime!	The timestamp at which the object was created.
details	String!	Additional information about the event.
id	ID!	The ID of the object
monitor	AlertMonitor!	The AlertMonitor to which the AlertEvent is associated.

---

alertEvents

Returns a Relay Connection to a collection of AlertEvent objects.

query {
  alertEvents {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
createdAt_Gte	DateTime	Filter for objects where createdAt occurs on or after the specified value.
createdAt_Lte	DateTime	Filter for objects where createdAt occurs on or before the specified value.
details_Icontains	String	Filter for objects where details contains the specified value (case insensitive).
monitor_Instance_Customer	ID	Filter for objects where monitor.instance.customer matches the specified ID.
monitor_Instance_Integration	ID	Filter for objects where monitor.instance.integration matches the specified ID.
monitor_Instance	ID	Filter for objects where monitor.instance matches the specified ID.
monitor_Instance_Name_Icontains	String	Filter for objects where monitor.instance.name contains the specified value (case insensitive).
monitor_Name_Icontains	String	Filter for objects where monitor.name contains the specified value (case insensitive).
monitor	ID	Filter for objects where monitor matches the specified ID.
monitor_FlowConfig	ID	Filter for objects where monitor.flowConfig matches the specified ID.
orderBy	AlertEventOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[AlertEventOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (AlertEventConnection!)

Field	Type	Description
edges	[AlertEventEdge]!	List of edges containing the nodes in this connection.
nodes	[AlertEvent]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

alertGroup

Returns the specified AlertGroup object.

query {
  alertGroup(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the AlertGroup object.

Return fields (AlertGroup)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the AlertGroup.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the AlertGroup.
createdAt	DateTime!	The timestamp at which the object was created.
id	ID!	The ID of the object
monitors	AlertMonitorConnection!	The AlertGroups to notify when the AlertMonitor is triggered.
name	String!	The name of the AlertGroup
updatedAt	DateTime!	The timestamp at which the object was most recently updated.
users	UserConnection!	The users in the AlertGroup.
webhooks	AlertWebhookConnection!	The AlertWebhooks in the AlertGroup

---

alertGroups

Returns a Relay Connection to a collection of AlertGroup objects.

query {
  alertGroups {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
createdAt_Gte	DateTime	Filter for objects where createdAt occurs on or after the specified value.
createdAt_Lte	DateTime	Filter for objects where createdAt occurs on or before the specified value.
updatedAt_Gte	DateTime	Filter for objects where updatedAt occurs on or after the specified value.
updatedAt_Lte	DateTime	Filter for objects where updatedAt occurs on or before the specified value.
orderBy	AlertGroupOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[AlertGroupOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (AlertGroupConnection!)

Field	Type	Description
edges	[AlertGroupEdge]!	List of edges containing the nodes in this connection.
nodes	[AlertGroup]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

alertMonitor

Returns the specified AlertMonitor object.

query {
  alertMonitor(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the AlertMonitor object.

Return fields (AlertMonitor)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the AlertMonitor.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the AlertMonitor.
createdAt	DateTime!	The timestamp at which the object was created.
durationSecondsCondition	Int	The execution duration condition to monitor for relevant AlertTrigger types.
events	AlertEventConnection!	The AlertMonitor to which the AlertEvent is associated.
executionOverdueMinutesCondition	Int	The execution overdue condition to monitor for relevant AlertTrigger types.
flowConfig	InstanceFlowConfig	The IntegrationFlow that is being monitored by the AlertMonitor.
groups	AlertGroupConnection!	The AlertGroups to notify when the AlertMonitor is triggered.
id	ID!	The ID of the object
instance	Instance	The Instance that is being monitored by the AlertMonitor.
lastTriggeredAt	DateTime	The timestamp when the AlertMonitor was last triggered.
logSeverityLevelCondition	Int	The log severity level condition to monitor for relevant AlertTrigger types.
name	String!	The name of the AlertMonitor.
systemSuspended	Boolean!	Specifies whether the Alert Monitor has been suspended by Prismatic.
triggered	Boolean!	Specifies whether the AlertMonitor is currently triggered.
triggers	AlertTriggerConnection!	The AlertTriggers that are setup to trigger the AlertMonitor.
updatedAt	DateTime!	The timestamp at which the object was most recently updated.
users	UserConnection!	The Users to notify when the AlertMonitor is triggered.
webhooks	AlertWebhookConnection!	The AlertWebhooks to call when the AlertMonitor is triggered.

---

alertMonitors

Returns a Relay Connection to a collection of AlertMonitor objects.

query {
  alertMonitors {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
name_Icontains	String	Filter for objects where name contains the specified value (case insensitive).
instance_Customer	ID	Filter for objects where instance.customer matches the specified ID.
instance_Integration	ID	Filter for objects where instance.integration matches the specified ID.
instance_Integration_VersionSequenceId	UUID	Filter for objects where instance.integration.versionSequenceId matches the specified value.
instance	ID	Filter for objects where instance matches the specified ID.
instance_Name_Icontains	String	Filter for objects where instance.name contains the specified value (case insensitive).
triggers	[ID]	Filter for objects where triggers contains at least one of the specified values.
triggers_Name_Icontains	String	Filter for objects where triggers.name contains the specified value (case insensitive).
triggers_IsGlobal	Boolean	Filter for objects where triggers.isGlobal matches the specified value.
triggered	Boolean	Filter for objects where triggered matches the specified value.
lastTriggeredAt_Gte	DateTime	Filter for objects where lastTriggeredAt occurs on or after the specified value.
lastTriggeredAt_Lte	DateTime	Filter for objects where lastTriggeredAt occurs on or before the specified value.
flowConfig	ID	Filter for objects where flowConfig matches the specified ID.
createdAt_Gte	DateTime	Filter for objects where createdAt occurs on or after the specified value.
createdAt_Lte	DateTime	Filter for objects where createdAt occurs on or before the specified value.
updatedAt_Gte	DateTime	Filter for objects where updatedAt occurs on or after the specified value.
updatedAt_Lte	DateTime	Filter for objects where updatedAt occurs on or before the specified value.
orderBy	AlertMonitorOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[AlertMonitorOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (AlertMonitorConnection!)

Field	Type	Description
edges	[AlertMonitorEdge]!	List of edges containing the nodes in this connection.
nodes	[AlertMonitor]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

alertTrigger

Returns the specified AlertTrigger object.

query {
  alertTrigger(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the AlertTrigger object.

Return fields (AlertTrigger)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the AlertTrigger.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the AlertTrigger.
id	ID!	The ID of the object
isGlobal	Boolean!	Specifies whether the AlertTrigger is global, rather than Instance or InstanceFlowConfig-specific.
isInstanceSpecific	Boolean!	Specifies whether the AlertTrigger is specific to an Instance rather than an InstanceFlowConfig.
monitors	AlertMonitorConnection!	The AlertTriggers that are setup to trigger the AlertMonitor.
name	String!	The name of the AlertTrigger.

---

alertTriggers

Returns a Relay Connection to a collection of AlertTrigger objects.

query {
  alertTriggers {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
isInstanceSpecific	Boolean	Filter for objects where isInstanceSpecific matches the specified value.
isGlobal	Boolean	Filter for objects where isGlobal matches the specified value.
orderBy	AlertTriggerOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[AlertTriggerOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (AlertTriggerConnection!)

Field	Type	Description
edges	[AlertTriggerEdge]!	List of edges containing the nodes in this connection.
nodes	[AlertTrigger]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

alertWebhook

Returns the specified AlertWebhook object.

query {
  alertWebhook(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the AlertWebhook object.

Return fields (AlertWebhook)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the AlertWebhook.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the AlertWebhook.
createdAt	DateTime!	The timestamp at which the object was created.
groups	AlertGroupConnection!	The AlertWebhooks in the AlertGroup
headers	JSONString	A JSON string of key/value pairs that will be sent as headers in the Webhook request.
id	ID!	The ID of the object
monitors	AlertMonitorConnection!	The AlertWebhooks to call when the AlertMonitor is triggered.
name	String!	The name of the AlertWebhook.
payloadTemplate	String!	The template that is hydrated and then used as the body of the AlertWebhook request.
updatedAt	DateTime!	The timestamp at which the object was most recently updated.
url	String!	The URL of the AlertWebhook.

---

alertWebhooks

Returns a Relay Connection to a collection of AlertWebhook objects.

query {
  alertWebhooks {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
name_Icontains	String	Filter for objects where name contains the specified value (case insensitive).
url_Icontains	String	Filter for objects where url contains the specified value (case insensitive).
createdAt_Gte	DateTime	Filter for objects where createdAt occurs on or after the specified value.
createdAt_Lte	DateTime	Filter for objects where createdAt occurs on or before the specified value.
updatedAt_Gte	DateTime	Filter for objects where updatedAt occurs on or after the specified value.
updatedAt_Lte	DateTime	Filter for objects where updatedAt occurs on or before the specified value.
orderBy	AlertWebhookOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[AlertWebhookOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (AlertWebhookConnection!)

Field	Type	Description
edges	[AlertWebhookEdge]!	List of edges containing the nodes in this connection.
nodes	[AlertWebhook]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

authenticatedUser

Returns the signed-in User.

query {
  authenticatedUser {
    id
  }
}

Return fields (User!)

Field	Type	Description
allowChangeRoles	Boolean!	Specifies whether the signed-in User can change the Role of the User.
allowRemove	Boolean!	Specifies whether the signed-in User can remove the User.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the User.
appAvatarUrl	String	The URL for the main avatar image that is displayed in Prismatic.
appName	String!	The app name displayed in Prismatic.
avatarUrl	String	The URL for the avatar image.
createdAt	DateTime!	The timestamp at which the object was created.
customer	Customer	The Customer the user belongs to, if any. If this is NULL then Organization will be specified.
darkMode	Boolean!	Designates whether the User has dark mode activated or not.
darkModeSyncWithOs	Boolean!	Designates whether dark mode should be derived from the operating system.
dateJoined	DateTime!	The date the User was created.
email	String!	The email address associated with the User.
externalId	String	Allows for mapping an external entity to a Prismatic record.
featureFlags	JSONString!
hideSensitiveCustomerDataEnabled	Boolean!	Specifies whether sensitive customer data hiding is enabled for this user's organization. When True, sensitive data (step outputs, logs, execution results, and connection inputs) is hidden from view. Customer users always have this set to False as they can always see their own data.
id	ID!	The ID of the object
marketplaceName	String!	The name displayed for the Marketplace.
name	String!	The user's preferred name.
org	Organization	The Organization that the User belongs to, if any. If this is NULL then Customer will be specified.
phone	String!	The preferred contact phone number for the User.
role	Role!	The Role associated with the User which determines its permissions.
tenantId	String!	The unique identifier for the tenant this user belongs to.
updatedAt	DateTime!	The timestamp at which the object was most recently updated.

---

authObjectType

Returns the specified AuthObjectType object.

query {
  authObjectType(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the AuthObjectType object.

Return fields (AuthObjectType)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the AuthObjectType.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the AuthObjectType.
id	ID!	The ID of the object
name	String!	Name of the AuthObjectType.

---

authObjectTypes

Returns a Relay Connection to a collection of AuthObjectType objects.

query {
  authObjectTypes {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
name	String	Filter for objects where name matches the specified value.
orderBy	AuthObjectTypeOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[AuthObjectTypeOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (AuthObjectTypeConnection!)

Field	Type	Description
edges	[AuthObjectTypeEdge]!	List of edges containing the nodes in this connection.
nodes	[AuthObjectType]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

authorizationMethod

Returns the specified AuthorizationMethod object.

query {
  authorizationMethod(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the AuthorizationMethod object.

Return fields (AuthorizationMethod)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the AuthorizationMethod.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the AuthorizationMethod.
description	String!	Additional notes about the AuthorizationMethod.
fields	CredentialFieldConnection!	The AuthorizationMethod that the CredentialField is associated to.
id	ID!	The ID of the object
key	String!	A string which uniquely identifies the AuthorizationMethod.
label	String!	The name of the AuthorizationMethod.

---

authorizationMethods

Returns a Relay Connection to a collection of AuthorizationMethod objects.

query {
  authorizationMethods {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int

Return fields (AuthorizationMethodConnection!)

Field	Type	Description
edges	[AuthorizationMethodEdge]!	List of edges containing the nodes in this connection.
nodes	[AuthorizationMethod]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

categories

DEPRECATED. Prefer using integrationCategories instead.

query {
  categories {
    id
  }
}

Return fields ([IntegrationCategory]!)

Field	Type	Description
id	ID!	The ID of the object
name	String!	The name of the Integration category.

---

component

Returns the specified Component object.

query {
  component(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the Component object.

Return fields (Component)

Field	Type	Description
actions	ActionConnection!	The Component to which this Action is associated.
allowManageAttachments	Boolean	Specifies whether the signed-in User can manage Attachments related to this record.
allowRemove	Boolean!	Specifies whether the signed-in User can remove the Component.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the Component.
attachments	[Attachment]	A JSON list of objects where each object has a key for name and URL that together describe the Attachment.
category	String	A string that specifies the category of the Component.
connections	ConnectionConnection!	The Component to which this Connection is associated.
customer	Customer	The Customer the Component belongs to, if any. If this is NULL then the Component belongs to the Organization.
description	String!	Additional notes about the Component.
documentationUrl	String	The URL associated with the documentation of a Component.
forCodeNativeIntegration	Boolean!	Specifies whether the Component was created inline as part of a Code Native Integration.
iconUrl	String	The URL that specifies where the Component icon exists.
id	ID!	The ID of the object
key	String!	A string that uniquely identifies the Component.
label	String!	The name of the Component.
labels	[String!]	The labels that are associated with the object.
public	Boolean!	Specifies whether the Component is publicly available or whether it's private to the Organization.
searchTerms	String	A combination of the Component label, Component description, and every Action label and Action description for the Component to be used for searching.
signature	String!	The hex-encoded SHA1 hash of the uploaded Component package.
sourceDownloadUrl	String	The URL that specifies where the Component source code bundle exists, if it is available.
starred	Boolean	Indicates whether the record is starred by the signed-in User.
versionAt	Component	Object data at specified version
versionAttributes	JSONString	Additional attributes that are specific to this version.
versionComment	String	Additional comments about this version.
versionCreatedAt	DateTime	Timestamp of the creation of this version.
versionCreatedBy	User	User that created this version.
versionIsAvailable	Boolean!	Indicates if the version is available for use.
versionIsLatest	Boolean!	Marked if this record is the latest version of this sequence.
versionNumber	Int!	Sequential number identifying this version.
versionSequence	ComponentConnection!	Sequence of versions of this Component
versionSequenceId	UUID	Identifier for this version sequence.
versions	VersionConnection	The Versions of the Component that are available.

---

componentActionSearchResults

Returns a list of Components and Actions that match the search criteria.

query {
  componentActionSearchResults(searchTerms: "example") {
    id
  }
}

Input fields

Argument	Type	Description
searchTerms	String!	String to use for searching the relevant fields of Components and Actions.
componentFilterQuery	JSONString	JSON structure defining a conditional logic expression tree to use for filtering Components.
actionFilterQuery	JSONString	JSON structure defining a conditional logic expression tree to use for filtering Actions.

Return type: ComponentActionSearchResult

---

componentCategories

Returns a list of Component categories.

query {
  componentCategories {
    id
  }
}

Return fields ([ComponentCategory]!)

Field	Type	Description
id	ID!	The ID of the object
name	String!	The name of the Component category.

---

componentLabels

Returns a list of unique Component labels.

query {
  componentLabels {
    id
  }
}

Return fields ([Label]!)

Field	Type	Description
id	ID!	The ID of the object
name	String!	The value of the label.

---

components

Returns a Relay Connection to a collection of Component objects.

query {
  components {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
allVersions	Boolean	Return all versions instead of only the latest
hasTriggers	Boolean	Return only Components that have Triggers
hasCommonTriggers	Boolean	Return only Components that have commonly-used Triggers
hasActions	Boolean	Return only Components that have Actions
hasConnections	Boolean	Return only Components that have Connections
hasOauth2Connections	Boolean	Return only Components that have at least one OAuth 2.0 Connection
hasSimpleConnections	Boolean	Return only Components that have at least one simple (non-OAuth 2.0) Connection
hasConnectionTemplates	Boolean	Return only Components that have at least one Connection that's templated
hasDataSources	Boolean	Return only Components that have Data Sources
hasDataSourcesOfType	String	Return only Components that have Data Sources of the specified type.
filterQuery	JSONString	JSON structure defining a conditional logic expression tree to use for including specific Actions.
includeComponentsForCodeNativeIntegrations	Boolean	Include Components that are for Code Native Integrations in addition to normal Components.
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
label_Icontains	String	Filter for objects where label contains the specified value (case insensitive).
description_Icontains	String	Filter for objects where description contains the specified value (case insensitive).
key	String	Filter for objects where key matches the specified value.
key_Icontains	String	Filter for objects where key contains the specified value (case insensitive).
key_In	[String]	Filter for objects where key is contained in the list of specified values.
category	String	Filter for objects where category matches the specified value.
searchTerms_Icontains	String	Filter for objects where searchTerms contains the specified value (case insensitive).
searchTerms_Fulltext	String	Filter for objects where searchTerms.fulltext matches the specified value.
public	Boolean	Filter for objects where public matches the specified value.
customer	ID	Filter for objects where customer matches the specified ID.
customer_Isnull	Boolean	Filter for objects where customer is NULL.
versionCreatedAt_Gte	DateTime	Filter for objects where versionCreatedAt occurs on or after the specified value.
versionCreatedAt_Lte	DateTime	Filter for objects where versionCreatedAt occurs on or before the specified value.
versionSequenceId	UUID	Filter for objects where versionSequenceId matches the specified value.
versionNumber	Int	Filter for objects where versionNumber matches the specified value.
versionIsAvailable	Boolean	Filter for objects where versionIsAvailable matches the specified value.
labels_Icontains	String	Filter for objects where labels contains the specified value (case insensitive).
labels_Contains	String	Filter for objects where labels contains the specified value (case sensitive).
orderBy	ComponentOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[ComponentOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (ComponentConnection!)

Field	Type	Description
edges	[ComponentEdge]!	List of edges containing the nodes in this connection.
nodes	[Component]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

connectionTemplate

Returns the specified ConnectionTemplate object.

query {
  connectionTemplate(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the ConnectionTemplate object.

Return fields (ConnectionTemplate)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the ConnectionTemplate.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the ConnectionTemplate.
connection	Connection!	The Connection from which this template is structured.
hasDeployedInstances	Boolean!	Indicates template is in use on an Instance.
id	ID!	The ID of the object
inputFieldTemplates	InputFieldTemplateConnection!	The template that this input is associated with.
instances	InstanceConnection!	Returns a list of deployed customer instances that are leveraging this template.
name	String!	The name of this template.
templatedInputKeys	[String]	Returns a list of the keys that are preset by this template.

---

connectionTemplates

Returns a Relay Connection to a collection of ConnectionTemplate objects.

query {
  connectionTemplates {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
connectionId	ID	Connection associated with this template.
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
name_Icontains	String	Filter for objects where name contains the specified value (case insensitive).
orderBy	ConnectionTemplateOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[ConnectionTemplateOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (ConnectionTemplateConnection!)

Field	Type	Description
edges	[ConnectionTemplateEdge]!	List of edges containing the nodes in this connection.
nodes	[ConnectionTemplate]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

credential

Returns the specified Credential object.

query {
  credential(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the Credential object.

Return fields (Credential)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the Credential.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the Credential.
authorizationError	String!	Contains any error message generated by the external authorizing system that occurred during authorization.
authorizationMethod	AuthorizationMethod!	The specific AuthorizationMethod used by the Credential.
context	JSONString	Contains OAuth2 context data if applicable.
customer	Customer	The Customer the Credential belongs to, if any. If NULL then Organization will be specified.
id	ID!	The ID of the object
label	String!	The name of the Credential.
org	Organization	The Organization the Credential belongs to, if any. If NULL then Customer will be specified.
readyForUse	Boolean!	Specifies whether the Credential is ready for use by an Instance.
redirectUri	String	Contains the OAuth2 Redirect URI if applicable.
refreshAt	DateTime	The timestamp at which the OAuth2 token will automatically be refreshed, if necessary. Only applies to OAuth2 methods where refresh is necessary.
token	JSONString	Contains OAuth2 token data if applicable.
values	[CredentialFieldValue]	A list of CredentialFieldValues that contain the values for the CredentialFields.

---

credentials

Returns a Relay Connection to a collection of Credential objects.

query {
  credentials {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
label_Icontains	String	Filter for objects where label contains the specified value (case insensitive).
customer	ID	Filter for objects where customer matches the specified ID.
customer_Isnull	Boolean	Filter for objects where customer is NULL.
readyForUse	Boolean	Filter for objects where readyForUse matches the specified value.
authorizationMethod_Key	String	Filter for objects where authorizationMethod.key matches the specified value.
orderBy	CredentialOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[CredentialOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (CredentialConnection!)

Field	Type	Description
edges	[CredentialEdge]!	List of edges containing the nodes in this connection.
nodes	[Credential]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

customer

Returns the specified Customer object.

query {
  customer(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the Customer object.

Return fields (Customer)

Field	Type	Description
allowAddAlertMonitor	Boolean!	Specifies whether the signed-in User can add an Alert Monitor to the Customer.
allowAddComponent	Boolean!	Specifies whether the signed-in User can add a Component to the Customer.
allowAddCredential	Boolean!	DEPRECATED. Specifies whether the signed-in User can add a Credential to the Customer.
allowAddCustomerConfigVariable	Boolean!	Specifies whether the signed-in User can add a Customer Config Variable to the Customer.
allowAddInstance	Boolean!	Specifies whether the signed-in User can add an Instance to the Customer.
allowAddIntegration	Boolean!	Specifies whether the signed-in User can add an Integration to the Customer.
allowAddUser	Boolean!	Specifies whether the signed-in User can add a User to the Customer.
allowConfigureCredentials	Boolean!	DEPRECATED. Specifies whether the signed-in User's Customer has access to legacy Credentials.
allowEmbeddedDesigner	Boolean!	Specifies whether this Customer can use the Embedded Designer.
allowEmbeddedWorkflowBuilder	Boolean!	Specifies whether this Customer can use the Embedded Workflow Builder.
allowEnableInstance	Boolean!	Specifies whether Instances may be enabled based on the utilization allowed by the current Plan.
allowExecuteInstance	Boolean!	Specifies whether Instances may be executed based on the utilization allowed by the current Plan.
allowManageAttachments	Boolean	Specifies whether the signed-in User can manage Attachments related to this record.
allowRemove	Boolean!	Specifies whether the signed-in User can remove the Customer.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the Customer.
attachments	[Attachment]	A JSON list of objects where each object has a key for name and URL that together describe the Attachment.
avatarUrl	String	The URL for the avatar image.
components	ComponentConnection!	The Customer the Component belongs to, if any. If this is NULL then the Component belongs to the Organization.
createdAt	DateTime!	The timestamp at which the object was created.
credentials	CredentialConnection!	The Customer the Credential belongs to, if any. If NULL then Organization will be specified.
description	String!	Additional notes about the Customer.
externalId	String	Allows for mapping an external entity to a Prismatic record.
id	ID!	The ID of the object
instances	InstanceConnection!	The Customer for which the Instance is deployed.
integrations	IntegrationConnection!	The Customer the Integration belongs to, if any. If this is NULL then the Integration belongs to the Organization.
labels	[String!]	The labels that are associated with the object.
name	String!	The name of the Customer, which must be unique within the scope of its Organization.
org	Organization!	The Organization to which the Customer belongs.
starred	Boolean	Indicates whether the record is starred by the signed-in User.
updatedAt	DateTime!	The timestamp at which the object was most recently updated.
users	UserConnection!	The Customer the user belongs to, if any. If this is NULL then Organization will be specified.

---

customerConfigVariable

Returns the specified CustomerConfigVariable object.

query {
  customerConfigVariable(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the CustomerConfigVariable object.

Return fields (CustomerConfigVariable)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the CustomerConfigVariable.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the CustomerConfigVariable.
authorizeUrl	String	The Authorize URL of this Config Variable if associated with an OAuth 2.0 Connection.
customer	Customer	The Customer with which this Config Variable is associated.
hasDeployedInstances	Boolean!	Indicates this config variable is in use on an Instance.
id	ID!	The ID of the object
inputs	ExpressionConnection	The collection of Expressions that serve as inputs to this variable.
instances	InstanceConnection!	Returns a list of Instances using this config variable.
integrations	IntegrationConnection!	Returns a list of Integrations using this config variable.
isInUse	Boolean!	Indicates that this config variable is currently in use by at least one Instance or Integration version.
isTest	Boolean!	Specifies whether this Config Variable is meant for testing.
key	String	The display name of this variable.
lastConfiguredAt	DateTime	The timestamp of the most recent inputs reconfiguration.
lastSuccessfulRefreshAt	DateTime	The timestamp of the last successful OAuth2 token refresh.
logs	LogConnection!	The CustomerConfigVariable which relates to the Log entry.
meta	JSONString	Contains arbitrary metadata about this variable.
refreshAt	DateTime	The timestamp at which the OAuth2 token will automatically be refreshed, if necessary. Only applies to OAuth2 methods where refresh is necessary.
scopedConfigVariable	ScopedConfigVariable!	The Scoped Config Variable with which this Config Variable is associated.
status	CustomerConfigVariableStatus	Status indicating if this Connection is working as expected or encountering issues.
workflows	WorkflowConnection!	Returns a list of Workflows using this config variable.

---

customerConfigVariables

Returns a Relay Connection to a collection of CustomerConfigVariable objects.

query {
  customerConfigVariables {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
id_In	[ID]	Filter for objects where id is contained in the list of specified values.
key	String	Filter for objects where key matches the specified value.
key_Isnull	Boolean	Filter for objects where key is NULL.
key_Icontains	String	Filter for objects where key contains the specified value (case insensitive).
customer	ID	Filter for objects where customer matches the specified ID.
isTest	Boolean	Filter for objects where isTest matches the specified value.
scopedConfigVariable	ID	Filter for objects where scopedConfigVariable matches the specified ID.
scopedConfigVariable_StableKey	String	Filter for objects where scopedConfigVariable.stableKey matches the specified value.
scopedConfigVariable_StableKey_Icontains	String	Filter for objects where scopedConfigVariable.stableKey contains the specified value (case insensitive).
scopedConfigVariable_Key	String	Filter for objects where scopedConfigVariable.key matches the specified value.
scopedConfigVariable_Key_Icontains	String	Filter for objects where scopedConfigVariable.key contains the specified value (case insensitive).
scopedConfigVariable_VariableScope	String	Filter for objects where scopedConfigVariable.variableScope matches the specified value.
scopedConfigVariable_ManagedBy	String	Filter for objects where scopedConfigVariable.managedBy matches the specified value.
status	String	Filter for objects where status matches the specified value.
status_In	[String]	Filter for objects where status is contained in the list of specified values.
connection_Component_In	[ComponentSelector]	Filter for objects where connection.component is contained in the list of specified values.
connection_Component_Label_Icontains	String	Filter for objects where connection.component.label contains the specified value (case insensitive).
orderBy	CustomerConfigVariableOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[CustomerConfigVariableOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (CustomerConfigVariableConnection!)

Field	Type	Description
edges	[CustomerConfigVariableEdge]!	List of edges containing the nodes in this connection.
nodes	[CustomerConfigVariable]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

customerLabels

Returns a list of unique Customer labels.

query {
  customerLabels {
    id
  }
}

Return fields ([Label]!)

Field	Type	Description
id	ID!	The ID of the object
name	String!	The value of the label.

---

customerRoles

Returns a list of Customer Role objects.

query {
  customerRoles {
    id
  }
}

Return fields ([Role]!)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the Role.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the Role.
description	String!	Description of the Role.
id	ID!	The ID of the object
level	Int!	An integer that specifies the level of privilege with respect to other Roles.
name	String!	The name of the Role. Must be unique within the context of the AuthObjectType.
objType	AuthObjectType!	The type of object that the Role is associated with.
permissions	PermissionConnection!	List of Permissions that the Role provides.

---

customers

Returns a Relay Connection to a collection of Customer objects.

query {
  customers {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
isSystem	Boolean	Filter for system-generated Customers.
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
name	String	Filter for objects where name matches the specified value.
name_Icontains	String	Filter for objects where name contains the specified value (case insensitive).
name_Istartswith	String	Filter for objects where name starts with the specified value (case insensitive).
description_Icontains	String	Filter for objects where description contains the specified value (case insensitive).
allowEmbeddedDesigner	Boolean	Filter for objects where allowEmbeddedDesigner matches the specified value.
createdAt_Gte	DateTime	Filter for objects where createdAt occurs on or after the specified value.
createdAt_Lte	DateTime	Filter for objects where createdAt occurs on or before the specified value.
updatedAt_Gte	DateTime	Filter for objects where updatedAt occurs on or after the specified value.
updatedAt_Lte	DateTime	Filter for objects where updatedAt occurs on or before the specified value.
externalId	String	Filter for objects where externalId matches the specified value.
externalId_Isnull	Boolean	Filter for objects where externalId is NULL.
labels_Icontains	String	Filter for objects where labels contains the specified value (case insensitive).
labels_Contains	String	Filter for objects where labels contains the specified value (case sensitive).
orderBy	CustomerOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[CustomerOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (CustomerConnection!)

Field	Type	Description
edges	[CustomerEdge]!	List of edges containing the nodes in this connection.
nodes	[Customer]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

customerTotalUsageMetric

Returns the specified CustomerTotalUsageMetrics object.

query {
  customerTotalUsageMetric(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the CustomerTotalUsageMetrics object.

Return fields (CustomerTotalUsageMetrics)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the CustomerTotalUsageMetrics.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the CustomerTotalUsageMetrics.
createdWorkflowCount	Int!	The total number of Workflows that have been created.
customer	Customer!	The Customer for which utilization metrics are being collected.
deployedInstanceCount	Int!	The total number of Instances that are deployed.
deployedUniqueIntegrationCount	Int!	The total number of unique Integrations that are deployed.
enabledWorkflowCount	Int!	The total number of Workflows that are enabled.
id	ID!	The ID of the object
snapshotTime	DateTime!	The time the utilization metrics snapshot was created.
userCount	Int!	The total number of Users that currently exist.

---

customerTotalUsageMetrics

Returns a Relay Connection to a collection of CustomerTotalUsageMetrics objects.

query {
  customerTotalUsageMetrics {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
onlyLatestDailySnapshots	Boolean	Specifies whether to only return the latest snapshot record for each day.
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
customer	ID	Filter for objects where customer matches the specified ID.
snapshotTime_Gte	DateTime	Filter for objects where snapshotTime occurs on or after the specified value.
snapshotTime_Lte	DateTime	Filter for objects where snapshotTime occurs on or before the specified value.
orderBy	CustomerTotalUsageMetricsOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[CustomerTotalUsageMetricsOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (CustomerTotalUsageMetricsConnection!)

Field	Type	Description
edges	[CustomerTotalUsageMetricsEdge]!	List of edges containing the nodes in this connection.
nodes	[CustomerTotalUsageMetrics]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

embedded

Requirements and configuration for embedded designer.

query {
  embedded {
    id
  }
}

Return fields (Embedded)

Field	Type	Description
brandedElements	JSONString!	Customized names for branded elements.
requiredComponents	ComponentConnection!	Set of Components required to be used in Embedded built Integrations.

---

executionResult

Returns the specified InstanceExecutionResult object.

query {
  executionResult(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the InstanceExecutionResult object.

Return fields (InstanceExecutionResult)

Field	Type	Description
allocatedMemoryMb	Int	The number of MB of memory allocated by the runtime to execute this Execution.
allowRemove	Boolean!	Specifies whether the signed-in User can remove the InstanceExecutionResult.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the InstanceExecutionResult.
canceledByExecution	InstanceExecutionResult	The Execution with a matching Unique Request ID that caused this Execution to be canceled.
endedAt	DateTime	The timestamp at which execution ended.
error	String	Any error message that occurred as part of Instance execution.
flow	IntegrationFlow	The specific IntegrationFlow that is associated with this Execution.
flowConfig	InstanceFlowConfig	The specific InstanceFlowConfig for the Instance being executed.
id	ID!	The ID of the object
instance	Instance	The Instance for which a specific InstanceFlowConfig is being executed.
instanceType	InstanceType
integration	Integration	The specific Integration that is associated with this Execution.
invokeType	InstanceExecutionResultInvokeType	The type of origin that this execution was triggered from.
isLre	Boolean!	Specifies whether this is a Long Running Execution.
isTestExecution	Boolean!	Specifies whether Execution was created as part of testing.
lineage	InstanceExecutionLineage!	A metadata object representing this Instance execution's relationship to other executions.
logs	LogConnection!	The specific InstanceExecutionResult that is associated with the Log entry.
maxRetryCount	Int	The maximum number of times that this Execution may be retried before failing.
queuedAt	DateTime	Timestamp when this execution was queued for processing.
replayForExecution	InstanceExecutionResult	The Execution for which this Execution is a replay.
replays	InstanceExecutionResultConnection!	The Execution for which this Execution is a replay.
requestPayloadMetadataUrl	String!	The presigned URL to fetch metadata of the request payload that was sent to invoke Instance execution.
requestPayloadUrl	String!	The presigned URL to download the request payload that was sent to invoke Instance execution.
responsePayloadMetadataUrl	String!	The presigned URL to fetch metadata of the response payload that was received from the Instance execution.
responsePayloadUrl	String!	The presigned URL to download the response payload that was received from the Instance execution.
resultType	InstanceExecutionResultResultType	The type of outcome from the Instance execution.
resumedAt	DateTime	Timestamp when this queued execution was resumed for processing.
retryAttempts	InstanceExecutionResultConnection!	The Execution for which this Execution is a retry attempt.
retryCount	Int	The number of times that this Execution has been retried.
retryForExecution	InstanceExecutionResult	The Execution for which this Execution is a retry attempt.
retryNextAt	DateTime	The timestamp at which the next scheduled retry will occur.
retryUniqueRequestId	String	A Unique Request ID to use for retry request cancellation.
spendMbSecs	Int	The spend for this Execution in MB-secs.
startedAt	DateTime!	The timestamp at which execution started.
status	ExecutionStatus!	The status of the Instance execution.
stepCount	Int	The number of steps in this Execution.
stepResults	InstanceStepResultConnection!	The InstanceExecutionResult to which the InstanceStepResult is associated.

---

executionResults

Returns a Relay Connection to a collection of InstanceExecutionResult objects.

query {
  executionResults {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
id	ID	Filter for objects where the ID matches the specified value.
id_In	[ID]
status	ExecutionStatus	The status of the Instance execution.
invokedBy	ExecutionInvokedByInput
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
instance	ID	Filter for objects where instance matches the specified ID.
instance_Isnull	Boolean	Filter for objects where instance is NULL.
instance_Customer	ID	Filter for objects where instance.customer matches the specified ID.
instance_Integration	ID	Filter for objects where instance.integration matches the specified ID.
instance_Integration_VersionSequenceId	UUID	Filter for objects where instance.integration.versionSequenceId matches the specified value.
integration	ID	Filter for objects where integration matches the specified ID.
integration_VersionSequenceId	UUID	Filter for objects where integration.versionSequenceId matches the specified value.
instance_IsSystem	Boolean	Filter for objects where instance.isSystem matches the specified value.
flowConfig	ID	Filter for objects where flowConfig matches the specified ID.
flowConfig_Flow	ID	Filter for objects where flowConfig.flow matches the specified ID.
flow	ID	Filter for objects where flow matches the specified ID.
flow_In	[ID]	Filter for objects where flow is contained in the list of specified values.
startedAt_Gte	DateTime	Filter for objects where startedAt occurs on or after the specified value.
startedAt_Lte	DateTime	Filter for objects where startedAt occurs on or before the specified value.
endedAt_Gte	DateTime	Filter for objects where endedAt occurs on or after the specified value.
endedAt_Lte	DateTime	Filter for objects where endedAt occurs on or before the specified value.
endedAt_Isnull	Boolean	Filter for objects where endedAt is NULL.
error_Isnull	Boolean	Filter for objects where error is NULL.
retryCount_Gte	Int	Filter for objects where retryCount.gte matches the specified value.
retryCount_Lte	Int	Filter for objects where retryCount.lte matches the specified value.
retryCount	Int	Filter for objects where retryCount matches the specified value.
maxRetryCount_Gte	Int	Filter for objects where maxRetryCount.gte matches the specified value.
maxRetryCount_Lte	Int	Filter for objects where maxRetryCount.lte matches the specified value.
maxRetryCount	Int	Filter for objects where maxRetryCount matches the specified value.
retryNextAt_Gte	DateTime	Filter for objects where retryNextAt occurs on or after the specified value.
retryNextAt_Lte	DateTime	Filter for objects where retryNextAt occurs on or before the specified value.
retryNextAt_Isnull	Boolean	Filter for objects where retryNextAt is NULL.
retryUniqueRequestId	String	Filter for objects where retryUniqueRequestId matches the specified value.
isTestExecution	Boolean	Filter for objects where isTestExecution matches the specified value.
replayForExecution_Isnull	Boolean	Filter for objects where replayForExecution is NULL.
invokeType_In	[String]	Filter for objects where invokeType is contained in the list of specified values.
resultType	String	Filter for objects where resultType matches the specified value.
resultType_In	[String]	Filter for objects where resultType is contained in the list of specified values.
isLre	Boolean	Filter for objects where isLre matches the specified value.
queuedAt_Gte	DateTime	Filter for objects where queuedAt occurs on or after the specified value.
queuedAt_Lte	DateTime	Filter for objects where queuedAt occurs on or before the specified value.
queuedAt_Isnull	Boolean	Filter for objects where queuedAt is NULL.
resumedAt_Gte	DateTime	Filter for objects where resumedAt occurs on or after the specified value.
resumedAt_Lte	DateTime	Filter for objects where resumedAt occurs on or before the specified value.
resumedAt_Isnull	Boolean	Filter for objects where resumedAt is NULL.
retryForExecution_Isnull	Boolean	Filter for objects where retryForExecution is NULL.
instanceType	InstanceType	Filter for objects where instanceType matches the specified value.
orderBy	InstanceExecutionResultOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[InstanceExecutionResultOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (InstanceExecutionResultConnection!)

Field	Type	Description
edges	[InstanceExecutionResultEdge]!	List of edges containing the nodes in this connection.
nodes	[InstanceExecutionResult]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

externalLogStream

Returns the specified ExternalLogStream object.

query {
  externalLogStream(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the ExternalLogStream object.

Return fields (ExternalLogStream)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the ExternalLogStream.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the ExternalLogStream.
createdAt	DateTime!	The timestamp at which the object was created.
headers	JSONString	A JSON string of key/value pairs that will be sent as headers in the ExternalLogStream request.
id	ID!	The ID of the object
name	String!	Name of the ExternalLogStream.
payloadTemplate	String!	The template that is hydrated and then used as the body of the ExternalLogStream request.
severityLevels	[LogSeverity]!	The Log severity levels for which Logs should be sent to the ExternalLogStream.
updatedAt	DateTime!	The timestamp at which the object was most recently updated.
url	String!	The URL of the ExternalLogStream.

---

externalLogStreams

Returns a Relay Connection to a collection of ExternalLogStream objects.

query {
  externalLogStreams {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
name_Icontains	String	Filter for objects where name contains the specified value (case insensitive).
createdAt_Gte	DateTime	Filter for objects where createdAt occurs on or after the specified value.
createdAt_Lte	DateTime	Filter for objects where createdAt occurs on or before the specified value.
updatedAt_Gte	DateTime	Filter for objects where updatedAt occurs on or after the specified value.
updatedAt_Lte	DateTime	Filter for objects where updatedAt occurs on or before the specified value.
orderBy	ExternalLogStreamOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[ExternalLogStreamOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (ExternalLogStreamConnection!)

Field	Type	Description
edges	[ExternalLogStreamEdge]!	List of edges containing the nodes in this connection.
nodes	[ExternalLogStream]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

instance

Returns the specified Instance object.

query {
  instance(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the Instance object.

Return fields (Instance)

Field	Type	Description
allowDeploy	Boolean	Specifies whether the signed-in User can deploy the Instance.
allowRemove	Boolean!	Specifies whether the signed-in User can remove the Instance.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the Instance.
allowUpdateConfigVariables	Boolean	Specifies whether the signed-in User can update config variables for the Instance.
configState	InstanceConfigState	Describes the state of configuration of this Instance.
configVariables	InstanceConfigVariableConnection!	The Instance with which the Config Variable is associated.
createdAt	DateTime!	The timestamp at which the object was created.
customer	Customer!	The Customer for which the Instance is deployed.
customerConfigVariables	CustomerConfigVariableConnection!	Returns a list of Customer Config Variables associated with this Instance.
deployedVersion	Int!	The specific version of the Instance that is deployed.
description	String!	Additional notes about the Instance.
designedBy	InstanceDesignedBy!	Indicates whether the Instance was deployed by a 'customer' or 'org'.
enabled	Boolean!	Specifies whether the Instance is currently enabled and in an executable state.
executionResults	InstanceExecutionResultConnection!	The Instance for which a specific InstanceFlowConfig is being executed.
flowConfigs	InstanceFlowConfigConnection!	The configuration for the IntegrationFlow associated with the Instance.
globalDebug	Boolean!	Specifies whether Instance executions should run in debug mode.
id	ID!	The ID of the object
inFailedState	Boolean	Specifies whether any of the Instance's Flow Configs are currently in a failed state.
instanceType	InstanceType
integration	Integration!	The Integration that has been deployed for the Instance.
isCustomerDeployable	Boolean	Specifies whether the Instance can be deployed through the Marketplace.
isCustomerUpgradeable	Boolean	Specifies whether the Instance can be upgraded through the Marketplace.
isSystem	Boolean!
labels	[String!]	The labels that are associated with the object.
lastDeployedAt	DateTime	The timestamp at which the Instance was most recently deployed.
lastExecutedAt	DateTime	The timestamp at which the Instance was most recently executed.
listeningMode	Boolean!	Specifies whether the Instance is in listening mode for webhook snapshot executions.
logs	LogConnection!	The Instance which created the Log entry.
logsDisabled	Boolean!	This field has been deprecated.
monitors	AlertMonitorConnection!	The Instance that is being monitored by the AlertMonitor.
name	String!	The name of the Instance.
needsDeploy	Boolean!	Specifies whether a deploy is needed to reflect the newest configuration for this Instance.
profile	InstanceProfile	The Instance Profile used by this Instance.
scopedConfigVariables	ScopedConfigVariableConnection!	Returns a list of Scoped Config Variables associated with this Instance.
starred	Boolean	Indicates whether the record is starred by the signed-in User.
stepResultsDisabled	Boolean!	This field has been deprecated.
systemSuspended	Boolean!	Specifies whether the Instance has been suspended by Prismatic.
updatedAt	DateTime!	The timestamp at which the object was most recently updated.
userLevelConfigVariables	CustomUserLevelConfigVariableConnection	The User Level Config variables for the requesting User on this Instance.
userLevelConfigs	UserLevelConfigConnection!	The Instance with which the User Level Config is associated.
workflow	Workflow	The Workflow that has been deployed by the Instance.

---

instanceDailyUsageMetric

Returns the specified InstanceDailyUsageMetrics object.

query {
  instanceDailyUsageMetric(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the InstanceDailyUsageMetrics object.

Return fields (InstanceDailyUsageMetrics)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the InstanceDailyUsageMetrics.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the InstanceDailyUsageMetrics.
failedExecutionCount	BigInt!	The number of failed executions of this Instance on the snapshot date.
id	ID!	The ID of the object
instance	Instance!	The Instance for which utilization metrics are being collected.
snapshotDate	Date!	The date the utilization metrics snapshot was created.
spendMbSecs	BigInt!	The execution spend for this Instance on the snapshot date in MB-secs.
stepCount	BigInt!	The number of steps executed for this Instance on the snapshot date.
successfulExecutionCount	BigInt!	The number of successful executions of this Instance on the snapshot date.

---

instanceDailyUsageMetrics

Returns a Relay Connection to a collection of InstanceDailyUsageMetrics objects.

query {
  instanceDailyUsageMetrics {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
instance	ID	Filter for objects where instance matches the specified ID.
snapshotDate_Gte	Date	Filter for objects where snapshotDate occurs on or after the specified value.
snapshotDate_Lte	Date	Filter for objects where snapshotDate occurs on or before the specified value.
snapshotDate	Date	Filter for objects where snapshotDate matches the specified value.
orderBy	InstanceDailyUsageMetricsOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[InstanceDailyUsageMetricsOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (InstanceDailyUsageMetricsConnection!)

Field	Type	Description
edges	[InstanceDailyUsageMetricsEdge]!	List of edges containing the nodes in this connection.
nodes	[InstanceDailyUsageMetrics]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

instanceFlowConfig

Returns the specified InstanceFlowConfig object.

query {
  instanceFlowConfig(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the InstanceFlowConfig object.

Return fields (InstanceFlowConfig)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the InstanceFlowConfig.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the InstanceFlowConfig.
apiKeys	[String]	An optional collection of API Keys any of which, when specified, will be required as a header value in all requests to trigger execution of this IntegrationFlow for the associated Instance.
executionResults	InstanceExecutionResultConnection!	The specific InstanceFlowConfig for the Instance being executed.
flow	IntegrationFlow!	The IntegrationFlow for which configuration is being specified for the associated Instance.
id	ID!	The ID of the object
inFailedState	Boolean!	Specifies whether the latest execution of this InstanceFlowConfig resulted in a failure.
instance	Instance!	The configuration for the IntegrationFlow associated with the Instance.
lastExecutedAt	DateTime	The timestamp at which the InstanceFlowConfig was most recently executed.
logs	LogConnection!	The IntegrationFlow which created the Log entry.
monitors	AlertMonitorConnection!	The IntegrationFlow that is being monitored by the AlertMonitor.
testContentType	String	Content type of the payload for testing the IntegrationFlow associated with the Instance.
testHeaders	JSONString	Headers for testing this IntegrationFlow associated with the Instance.
testPayload	String	Data payload for testing this IntegrationFlow associated with the Instance.
usesLre	Boolean!	Specifies whether executions of this InstanceFlowConfig will use Long Running Executions.
webhookUrl	String!	The URL of the endpoint that triggers execution of the InstanceFlowConfig.

---

instanceFlowConfigs

Returns a Relay Connection to a collection of InstanceFlowConfig objects.

query {
  instanceFlowConfigs {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
flow_Name	String	Filter for objects where flow.name matches the specified value.
inFailedState	Boolean	Filter for objects where inFailedState matches the specified value.
orderBy	InstanceFlowConfigOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[InstanceFlowConfigOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (InstanceFlowConfigConnection!)

Field	Type	Description
edges	[InstanceFlowConfigEdge]!	List of edges containing the nodes in this connection.
nodes	[InstanceFlowConfig]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

instanceLabels

Returns a list of unique Instance labels.

query {
  instanceLabels {
    id
  }
}

Return fields ([Label]!)

Field	Type	Description
id	ID!	The ID of the object
name	String!	The value of the label.

---

instanceProfile

Returns the specified InstanceProfile object.

query {
  instanceProfile(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the InstanceProfile object.

Return fields (InstanceProfile)

Field	Type	Description
allocatedMemoryMb	Int!	The amount of memory allocated to the Instance Runner Lambda function.
allowRemove	Boolean!	Specifies whether the signed-in User can remove the InstanceProfile.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the InstanceProfile.
description	String	Additional notes about the Instance Profile.
id	ID!	The ID of the object
instanceBillingType	String!	The billing type for the Instances that use this Instance Profile.
instances	InstanceConnection!	The Instance Profile used by this Instance.
isDefaultProfile	Boolean!	Specifies whether this Instance Profile is the default used when no Instance Profile is explicitly specified during Instance creation.
logsDisabled	Boolean!	Specifies whether to disable the creation of logs during Instance execution.
name	String!	The name of the Instance Profile, which must be unique within the scope of its Organization.
quickStart	Boolean	Specifies whether instances using this profile will startup faster when triggered.
quickStartInstances	Int	The number of QuickStart Lambda runners reserved for Instances using this profile.
stepResultsDisabled	Boolean!	Specifies whether to disable the creation of step results during Instance execution.

---

instanceProfiles

Returns a Relay Connection to a collection of InstanceProfile objects.

query {
  instanceProfiles {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
name_Icontains	String	Filter for objects where name contains the specified value (case insensitive).
name	String	Filter for objects where name matches the specified value.
description_Icontains	String	Filter for objects where description contains the specified value (case insensitive).
description	String	Filter for objects where description matches the specified value.
isDefaultProfile	Boolean	Filter for objects where isDefaultProfile matches the specified value.
orderBy	InstanceProfileOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[InstanceProfileOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (InstanceProfileConnection!)

Field	Type	Description
edges	[InstanceProfileEdge]!	List of edges containing the nodes in this connection.
nodes	[InstanceProfile]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

instances

Returns a Relay Connection to a collection of Instance objects.

query {
  instances {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
isSystem	Boolean	Filter for system-generated Instances.
compatibility	Int	Opt in to new behavior.
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
id_In	[ID]	Filter for objects where id is contained in the list of specified values.
name_Icontains	String	Filter for objects where name contains the specified value (case insensitive).
name	String	Filter for objects where name matches the specified value.
description_Icontains	String	Filter for objects where description contains the specified value (case insensitive).
description	String	Filter for objects where description matches the specified value.
integration	ID	Filter for objects where integration matches the specified ID.
customer	ID	Filter for objects where customer matches the specified ID.
customer_ExternalId	String	Filter for objects where customer.externalId matches the specified value.
enabled	Boolean	Filter for objects where enabled matches the specified value.
needsDeploy	Boolean	Filter for objects where needsDeploy matches the specified value.
createdAt_Gte	DateTime	Filter for objects where createdAt occurs on or after the specified value.
createdAt_Lte	DateTime	Filter for objects where createdAt occurs on or before the specified value.
updatedAt_Gte	DateTime	Filter for objects where updatedAt occurs on or after the specified value.
updatedAt_Lte	DateTime	Filter for objects where updatedAt occurs on or before the specified value.
integration_VersionSequenceId	UUID	Filter for objects where integration.versionSequenceId matches the specified value.
globalDebug	Boolean	Filter for objects where globalDebug matches the specified value.
labels_Contains	String	Filter for objects where labels contains the specified value (case sensitive).
labels_Icontains	String	Filter for objects where labels contains the specified value (case insensitive).
designedBy	InstanceDesignedBy	Filter for objects where designedBy matches the specified value.
instanceType	InstanceType	Filter for objects where instanceType matches the specified value.
inFailedState	Boolean	Filter for objects where inFailedState matches the specified value.
orderBy	InstanceOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[InstanceOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (InstanceConnection!)

Field	Type	Description
edges	[InstanceEdge]!	List of edges containing the nodes in this connection.
nodes	[Instance]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

integration

Returns the specified Integration object.

query {
  integration(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the Integration object.

Return fields (Integration)

Field	Type	Description
actions	IntegrationActionConnection!	The Integration to which the IntegrationAction is associated via the IntegrationFlow.
agentFlowsUrl	String!	The URL for agent flows of this Integration.
allowFork	Boolean!	Specifies whether the signed-in User can fork the Integration.
allowManageAttachments	Boolean	Specifies whether the signed-in User can manage Attachments related to this record.
allowMultipleMarketplaceInstances	Boolean!	Specifies whether multiple Instances of this Integration may be created from the Marketplace.
allowPublish	Boolean!	Specifies whether the signed-in User can publish the Integration.
allowRemove	Boolean!	Specifies whether the signed-in User can remove the Integration.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the Integration.
attachments	[Attachment]	A JSON list of objects where each object has a key for name and URL that together describe the Attachment.
avatarUrl	String	The URL for the avatar image.
category	String	Specifies the category of the Integration.
components	ComponentConnection!	Components associated with this Integration
configPages	JSONString!	A JSON string that represents deployment configuration pages.
createdAt	DateTime!	The timestamp at which the object was created.
customer	Customer	The Customer the Integration belongs to, if any. If this is NULL then the Integration belongs to the Organization.
customerConfigVariables	CustomerConfigVariableConnection!	Returns a list of Customer Config Variables associated with this Integration.
defaultInstanceProfile	InstanceProfile	The Instance Profile to use as a default when Instances of this Integration are created.
definition	String	The YAML that is the declarative definition for the Integration. Suitable for using to re-import the Integration.
deployedInstances	DeployedInstancesQuantity!	Indicates how many Instances of this Integration are deployed.
deploymentStatus	AggregateDeploymentStatus	Indicates the lowest instance-level configuration status among all Instances.
description	String	Additional notes about the Integration.
documentation	String	Rich text documentation to accompany the Integration.
endpointConfigTestContentType	String	Content type of the payload for testing the endpoint configuration for this Integration.
endpointConfigTestHeaders	JSONString	A JSON string of key/value pairs that will be sent as headers when testing the endpoint configuration for this Integration.
endpointConfigTestPayload	String	Data payload for testing the endpoint configuration for this Integration.
endpointConfigTestUrl	String!	The URL of the endpoint that allows testing the endpoint configuration of the Integration.
endpointType	IntegrationEndpointType	Specifies whether endpoint URLs for Instances of this Integration are unique to the flow, unique to the Instance, or if all Instances share a URL.
externalVersion	String	Specifies the external version of this Integration, which can be used to provide semantic versioning.
firstDeployedInstance	Instance	The first instance using this Integration.
flows	IntegrationFlowConnection!	The Integration of which the IntegrationFlow is a part.
hasOutdatedComponents	Boolean!	Specifies whether the Integration uses outdated Components
hasUnpublishedChanges	Boolean!	Specifies whether the Integration definition has changes that have not yet been published.
id	ID!	The ID of the object
instanceStats	InstanceStats!	Aggregated statistics about Instances deployed for this Integration.
instances	InstanceConnection!	The Integration that has been deployed for the Instance.
isCodeNative	Boolean!	Specifies whether this Integration is a Code Native Integration.
isCustomerDeployable	Boolean	Specifies whether the Integration can be deployed by the signed-in User.
labels	[String!]	The labels that are associated with the object.
lastExecutedAt	DateTime	The timestamp at which this Integration was most recently executed as part of an Instance.
marketplaceConfiguration	MarketplaceConfiguration!	Specifies whether an Integration will be available in the Integration Marketplace and if the Integration is deployable by a Customer User.
marketplaceTabConfiguration	[String!]	The Marketplace Tabs available to Customer Users for configuring this Integration.
metadata	JSONString	A JSON string that represents metadata for the Integration.
name	String!	The name of the Integration.
overview	String	Specifies an Overview of the Integration to describe its functionality for use in the Integration Marketplace.
parent	Integration	Parent Integration this Integration was forked from, if any
preprocessFlowName	String	The name of a Flow in the Integration that will be executed as a preprocessing step prior to any other Flow executions.
requiredConfigVariables	RequiredConfigVariableConnection!
scopedConfigVariables	ScopedConfigVariableConnection!	Returns a list of Scoped Config Variables associated with this Integration.
starred	Boolean	Indicates whether the record is starred by the signed-in User.
storeConfiguration	IntegrationStoreConfiguration	Specifies whether an Integration will be available in the Integration Store and if the Integration is deployable by a Customer User.
systemInstance	Instance!	System Instance backing this Integration.
templateConfiguration	IntegrationTemplateConfiguration!	Specifies whether the latest published version of this Integration may be used as a template to create new Integrations.
testConfigVariables	InstanceConfigVariableConnection!	Config Variables that are used for testing during Integration design.
ulcDeploymentStatus	AggregateDeploymentStatus	Indicates the lowest user-level configuration status among all Instances.
updatedAt	DateTime!	The timestamp at which the object was most recently updated.
useAsTemplate	Boolean!	Specifies whether the latest published version of this Integration may be used as a template to create new Integrations.
userLevelConfigured	Boolean!	Specifies whether this Integration uses User Level Configs.
validationRules	IntegrationValidationRules!	Validation Rules applied to this Integration.
versionAt	Integration	Object data at specified version
versionAttributes	JSONString	Additional attributes that are specific to this version.
versionComment	String	Additional comments about this version.
versionCreatedAt	DateTime	Timestamp of the creation of this version.
versionCreatedBy	User	User that created this version.
versionIsAvailable	Boolean!	Indicates if the version is available for use.
versionIsLatest	Boolean!	Marked if this record is the latest version of this sequence.
versionNumber	Int!	Sequential number identifying this version.
versionSequence	IntegrationConnection!	Sequence of versions of this Integration
versionSequenceId	UUID	Identifier for this version sequence.
versions	VersionConnection!	The Versions of the Integration that are available.

---

integrationCategories

Returns a list of Integration categories.

query {
  integrationCategories {
    id
  }
}

Input fields

Argument	Type	Description
onlyLatest	Boolean	Only include categories that appear on the latest versions of Integrations.
onlyPublished	Boolean	Only include categories that appear on published versions of Integrations.
fromTemplates	Boolean	Include categories defined by templates.

Return fields ([IntegrationCategory]!)

Field	Type	Description
id	ID!	The ID of the object
name	String!	The name of the Integration category.

---

integrationLabels

Returns a list of unique Integration labels.

query {
  integrationLabels {
    id
  }
}

Return fields ([Label]!)

Field	Type	Description
id	ID!	The ID of the object
name	String!	The value of the label.

---

integrations

Returns a Relay Connection to a collection of Integration objects.

query {
  integrations {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
name	String	Filter for objects where name matches the specified value.
name_Icontains	String	Filter for objects where name contains the specified value (case insensitive).
description	String	Filter for objects where description matches the specified value.
description_Icontains	String	Filter for objects where description contains the specified value (case insensitive).
hasUnpublishedChanges	Boolean	Filter for objects where hasUnpublishedChanges matches the specified value.
category	String	Filter for objects where category matches the specified value.
category_Icontains	String	Filter for objects where category contains the specified value (case insensitive).
marketplaceConfiguration_Istartswith	String	Filter for objects where marketplaceConfiguration starts with the specified value (case insensitive).
marketplaceConfiguration_Iexact	String	Filter for objects where marketplaceConfiguration.iexact matches the specified value.
marketplaceConfiguration_In	[String]	Filter for objects where marketplaceConfiguration is contained in the list of specified values.
customer	ID	Filter for objects where customer matches the specified ID.
customer_Isnull	Boolean	Filter for objects where customer is NULL.
useAsTemplate	Boolean	Filter for objects where useAsTemplate matches the specified value.
templateConfiguration_Istartswith	String	Filter for objects where templateConfiguration starts with the specified value (case insensitive).
templateConfiguration_Iexact	String	Filter for objects where templateConfiguration.iexact matches the specified value.
templateConfiguration_In	[String]	Filter for objects where templateConfiguration is contained in the list of specified values.
allowMultipleMarketplaceInstances	Boolean	Filter for objects where allowMultipleMarketplaceInstances matches the specified value.
createdAt_Gte	DateTime	Filter for objects where createdAt occurs on or after the specified value.
createdAt_Lte	DateTime	Filter for objects where createdAt occurs on or before the specified value.
updatedAt_Gte	DateTime	Filter for objects where updatedAt occurs on or after the specified value.
updatedAt_Lte	DateTime	Filter for objects where updatedAt occurs on or before the specified value.
isCodeNative	Boolean	Filter for objects where isCodeNative matches the specified value.
flows_IsAgentFlow	Boolean	Filter for objects where flows.isAgentFlow matches the specified value.
versionSequenceId	UUID	Filter for objects where versionSequenceId matches the specified value.
versionNumber	Int	Filter for objects where versionNumber matches the specified value.
versionIsAvailable	Boolean	Filter for objects where versionIsAvailable matches the specified value.
labels_Contains	String	Filter for objects where labels contains the specified value (case sensitive).
labels_Icontains	String	Filter for objects where labels contains the specified value (case insensitive).
marketplace	Boolean	Filter for objects where marketplace matches the specified value.
allVersions	Boolean	Filter for objects where allVersions matches the specified value.
hasInstances	Boolean	Filter for objects where hasInstances matches the specified value.
hasOutdatedComponents	Boolean	Filter for objects where hasOutdatedComponents matches the specified value.
orderBy	IntegrationOrder	DEPRECATED. 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.

Return fields (IntegrationConnection!)

Field	Type	Description
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.

---

integrationVariants

Query for integrationVariants.

query {
  integrationVariants {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String
after	String
first	Int
last	Int
hasUnpublishedChanges	Boolean
marketplaceConfiguration_Istartswith	String
marketplaceConfiguration_Iexact	String
marketplaceConfiguration_In	String
useAsTemplate	Boolean
templateConfiguration_Istartswith	String
templateConfiguration_Iexact	String
templateConfiguration_In	String
allowMultipleMarketplaceInstances	Boolean
isCodeNative	Boolean
flows_IsAgentFlow	Boolean
marketplace	Boolean
hasInstances	Boolean
hasOutdatedComponents	Boolean
name	String
name_Icontains	String
description	String
description_Icontains	String
customer	ID
customer_Isnull	Boolean
createdAt_Gte	DateTime
createdAt_Lte	DateTime
updatedAt_Gte	DateTime
updatedAt_Lte	DateTime
category	String
category_Icontains	String
labels_Contains	String
labels_Icontains	String
draft	Boolean
allVersions	Boolean
sortBy	[IntegrationVariantOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (IntegrationVariantConnection)

Field	Type	Description
edges	[IntegrationVariantEdge]!	List of edges containing the nodes in this connection.
nodes	[IntegrationVariant]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

listUserTenants

Returns a list of tenants that the current user has access to.

query {
  listUserTenants {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
includeAllStacks	Boolean	When True, returns tenants from all stacks. When False (default), we'll only return tenants for the current stack.

Return fields (UserTenantsConnection!)

Field	Type	Description
nodes	[UserTenantAccess!]!	List of tenant access nodes.

---

log

Returns the specified Log object.

query {
  log(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the Log object.

Return fields (Log)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the Log.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the Log.
configVariable	InstanceConfigVariable	The InstanceConfigVariable which relates to the Log entry.
customer	Customer	The specific Customer that is associated with the Log entry.
customerConfigVariable	CustomerConfigVariable	The CustomerConfigVariable which relates to the Log entry.
customerName	String	The name of the Customer that is associated with the Log entry.
executionResult	InstanceExecutionResult	The specific InstanceExecutionResult that is associated with the Log entry.
executionResultId	ID	The ID of the Execution Result which created the Log entry.
flow	IntegrationFlow	The specific IntegrationFlow that is associated with the Log entry.
flowConfig	InstanceFlowConfig	The IntegrationFlow which created the Log entry.
flowName	String	The name of the IntegrationFlow that is associated with the Log entry.
fromPreprocessFlow	Boolean	Specifies whether the Log was generated as part of the associated Integration's Preprocess Flow.
id	ID!	The ID of the object
instance	Instance	The Instance which created the Log entry.
instanceId	ID	The ID of the Instance which created the Log entry.
instanceName	String	The name of the Instance which created the Log entry.
instanceType	InstanceType
integration	Integration	The specific Integration that is associated with the Log entry.
integrationName	String	The name of the Integration that is associated with the Log entry.
integrationVersionSequenceId	UUID	The identifier for the version sequence of the Integration that is associated with the Log entry.
isTestExecution	Boolean	Specifies whether the associated Execution was created as part of testing.
logType	LogType	The type of Log entry.
loopPath	String	A string containing a sequence of space-separated 'loopStepName:iterationNumber' tokens that allow this Log to be requested based solely on loop positions and iteration numbers
loopStepIndex	Int	The iteration index of the containing Loop IntegrationAction at the time this Log entry was generated, if any.
loopStepName	String	The name of the IntegrationAction that is the Loop containing the IntegrationAction that generated this Log entry, if any.
message	String!	The message body of the Log entry.
requiredConfigVariableKey	String	The key of the Required Config Variable which relates to the Log entry.
scopedConfigVariable	ScopedConfigVariable	The ScopedConfigVariable which relates to the Log entry.
severity	LogSeverityLevel!	The severity level of the Log entry.
stepName	String	The name of the IntegrationAction that generated this Log entry.
timestamp	DateTime!	The timestamp at which the Log was created.
userLevelConfigVariable	UserLevelConfigVariable	The UserLevelConfigVariable which relates to the Log entry.

---

logs

Returns a Relay Connection to a collection of Log objects.

query {
  logs {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
executionResult_IsTestExecution	Boolean	Filter for objects where executionResult.isTestExecution matches the specified value.
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
message_Icontains	String	Filter for objects where message contains the specified value (case insensitive).
timestamp_Gte	DateTime	Filter for objects where timestamp occurs on or after the specified value.
timestamp_Lte	DateTime	Filter for objects where timestamp occurs on or before the specified value.
logType	String	Filter for objects where logType matches the specified value.
logType_In	[String]	Filter for objects where logType is contained in the list of specified values.
severity	Int	Filter for objects where severity matches the specified value.
executionResult	ID	Filter for objects where executionResult matches the specified ID.
isTestExecution	Boolean	Filter for objects where isTestExecution matches the specified value.
instance_Customer	ID	Filter for objects where instance.customer matches the specified ID.
customer	ID	Filter for objects where customer matches the specified ID.
instance_Integration	ID	Filter for objects where instance.integration matches the specified ID.
instance	ID	Filter for objects where instance matches the specified ID.
instance_IsSystem	Boolean	Filter for objects where instance.isSystem matches the specified value.
flowConfig	ID	Filter for objects where flowConfig matches the specified ID.
flowConfig_Flow	ID	Filter for objects where flowConfig.flow matches the specified ID.
configVariable_Isnull	Boolean	Filter for objects where configVariable is NULL.
userLevelConfigVariable_Isnull	Boolean	Filter for objects where userLevelConfigVariable is NULL.
integration	ID	Filter for objects where integration matches the specified ID.
integration_VersionSequenceId	UUID	Filter for objects where integration.versionSequenceId matches the specified value.
integrationVersionSequenceId	UUID	Filter for objects where integrationVersionSequenceId matches the specified value.
flow	ID	Filter for objects where flow matches the specified ID.
loopPath	String	Filter for objects where loopPath matches the specified value.
loopPath_Istartswith	String	Filter for objects where loopPath starts with the specified value (case insensitive).
scopedConfigVariable	ID	Filter for objects where scopedConfigVariable matches the specified ID.
customerConfigVariable	ID	Filter for objects where customerConfigVariable matches the specified ID.
requiredConfigVariableKey	String	Filter for objects where requiredConfigVariableKey matches the specified value.
instanceType	InstanceType	Filter for objects where instanceType matches the specified value.
orderBy	LogOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[LogOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (LogConnection!)

Field	Type	Description
edges	[LogEdge]!	List of edges containing the nodes in this connection.
nodes	[Log]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

logSeverityLevels

Returns a list of LogSeverity objects.

query {
  logSeverityLevels {
    id
  }
}

Return fields ([LogSeverity]!)

Field	Type	Description
id	Int
name	String

---

marketplaceIntegration

Returns the specified Integration object.

query {
  marketplaceIntegration(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the Integration object.

Return fields (Integration)

Field	Type	Description
actions	IntegrationActionConnection!	The Integration to which the IntegrationAction is associated via the IntegrationFlow.
agentFlowsUrl	String!	The URL for agent flows of this Integration.
allowFork	Boolean!	Specifies whether the signed-in User can fork the Integration.
allowManageAttachments	Boolean	Specifies whether the signed-in User can manage Attachments related to this record.
allowMultipleMarketplaceInstances	Boolean!	Specifies whether multiple Instances of this Integration may be created from the Marketplace.
allowPublish	Boolean!	Specifies whether the signed-in User can publish the Integration.
allowRemove	Boolean!	Specifies whether the signed-in User can remove the Integration.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the Integration.
attachments	[Attachment]	A JSON list of objects where each object has a key for name and URL that together describe the Attachment.
avatarUrl	String	The URL for the avatar image.
category	String	Specifies the category of the Integration.
components	ComponentConnection!	Components associated with this Integration
configPages	JSONString!	A JSON string that represents deployment configuration pages.
createdAt	DateTime!	The timestamp at which the object was created.
customer	Customer	The Customer the Integration belongs to, if any. If this is NULL then the Integration belongs to the Organization.
customerConfigVariables	CustomerConfigVariableConnection!	Returns a list of Customer Config Variables associated with this Integration.
defaultInstanceProfile	InstanceProfile	The Instance Profile to use as a default when Instances of this Integration are created.
definition	String	The YAML that is the declarative definition for the Integration. Suitable for using to re-import the Integration.
deployedInstances	DeployedInstancesQuantity!	Indicates how many Instances of this Integration are deployed.
deploymentStatus	AggregateDeploymentStatus	Indicates the lowest instance-level configuration status among all Instances.
description	String	Additional notes about the Integration.
documentation	String	Rich text documentation to accompany the Integration.
endpointConfigTestContentType	String	Content type of the payload for testing the endpoint configuration for this Integration.
endpointConfigTestHeaders	JSONString	A JSON string of key/value pairs that will be sent as headers when testing the endpoint configuration for this Integration.
endpointConfigTestPayload	String	Data payload for testing the endpoint configuration for this Integration.
endpointConfigTestUrl	String!	The URL of the endpoint that allows testing the endpoint configuration of the Integration.
endpointType	IntegrationEndpointType	Specifies whether endpoint URLs for Instances of this Integration are unique to the flow, unique to the Instance, or if all Instances share a URL.
externalVersion	String	Specifies the external version of this Integration, which can be used to provide semantic versioning.
firstDeployedInstance	Instance	The first instance using this Integration.
flows	IntegrationFlowConnection!	The Integration of which the IntegrationFlow is a part.
hasOutdatedComponents	Boolean!	Specifies whether the Integration uses outdated Components
hasUnpublishedChanges	Boolean!	Specifies whether the Integration definition has changes that have not yet been published.
id	ID!	The ID of the object
instanceStats	InstanceStats!	Aggregated statistics about Instances deployed for this Integration.
instances	InstanceConnection!	The Integration that has been deployed for the Instance.
isCodeNative	Boolean!	Specifies whether this Integration is a Code Native Integration.
isCustomerDeployable	Boolean	Specifies whether the Integration can be deployed by the signed-in User.
labels	[String!]	The labels that are associated with the object.
lastExecutedAt	DateTime	The timestamp at which this Integration was most recently executed as part of an Instance.
marketplaceConfiguration	MarketplaceConfiguration!	Specifies whether an Integration will be available in the Integration Marketplace and if the Integration is deployable by a Customer User.
marketplaceTabConfiguration	[String!]	The Marketplace Tabs available to Customer Users for configuring this Integration.
metadata	JSONString	A JSON string that represents metadata for the Integration.
name	String!	The name of the Integration.
overview	String	Specifies an Overview of the Integration to describe its functionality for use in the Integration Marketplace.
parent	Integration	Parent Integration this Integration was forked from, if any
preprocessFlowName	String	The name of a Flow in the Integration that will be executed as a preprocessing step prior to any other Flow executions.
requiredConfigVariables	RequiredConfigVariableConnection!
scopedConfigVariables	ScopedConfigVariableConnection!	Returns a list of Scoped Config Variables associated with this Integration.
starred	Boolean	Indicates whether the record is starred by the signed-in User.
storeConfiguration	IntegrationStoreConfiguration	Specifies whether an Integration will be available in the Integration Store and if the Integration is deployable by a Customer User.
systemInstance	Instance!	System Instance backing this Integration.
templateConfiguration	IntegrationTemplateConfiguration!	Specifies whether the latest published version of this Integration may be used as a template to create new Integrations.
testConfigVariables	InstanceConfigVariableConnection!	Config Variables that are used for testing during Integration design.
ulcDeploymentStatus	AggregateDeploymentStatus	Indicates the lowest user-level configuration status among all Instances.
updatedAt	DateTime!	The timestamp at which the object was most recently updated.
useAsTemplate	Boolean!	Specifies whether the latest published version of this Integration may be used as a template to create new Integrations.
userLevelConfigured	Boolean!	Specifies whether this Integration uses User Level Configs.
validationRules	IntegrationValidationRules!	Validation Rules applied to this Integration.
versionAt	Integration	Object data at specified version
versionAttributes	JSONString	Additional attributes that are specific to this version.
versionComment	String	Additional comments about this version.
versionCreatedAt	DateTime	Timestamp of the creation of this version.
versionCreatedBy	User	User that created this version.
versionIsAvailable	Boolean!	Indicates if the version is available for use.
versionIsLatest	Boolean!	Marked if this record is the latest version of this sequence.
versionNumber	Int!	Sequential number identifying this version.
versionSequence	IntegrationConnection!	Sequence of versions of this Integration
versionSequenceId	UUID	Identifier for this version sequence.
versions	VersionConnection!	The Versions of the Integration that are available.

---

marketplaceIntegrations

Returns a Relay Connection to a collection of Integration objects.

query {
  marketplaceIntegrations {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
activated	Boolean	Return only activated Integrations
includeActiveIntegrations	Boolean	Include non-marketplace integrations deployed to the customer of the caller
filterQuery	JSONString	JSON structure defining a conditional logic expression tree to use for including specific Integrations.
strictMatchFilterQuery	Boolean	If true, filterQuery will be evaluated by ANDing the conditions with activated and includeActiveIntegrations. If false, it will be evaluated using OR.
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
name	String	Filter for objects where name matches the specified value.
name_Icontains	String	Filter for objects where name contains the specified value (case insensitive).
description	String	Filter for objects where description matches the specified value.
description_Icontains	String	Filter for objects where description contains the specified value (case insensitive).
hasUnpublishedChanges	Boolean	Filter for objects where hasUnpublishedChanges matches the specified value.
category	String	Filter for objects where category matches the specified value.
category_Icontains	String	Filter for objects where category contains the specified value (case insensitive).
marketplaceConfiguration_Istartswith	String	Filter for objects where marketplaceConfiguration starts with the specified value (case insensitive).
marketplaceConfiguration_Iexact	String	Filter for objects where marketplaceConfiguration.iexact matches the specified value.
marketplaceConfiguration_In	[String]	Filter for objects where marketplaceConfiguration is contained in the list of specified values.
customer	ID	Filter for objects where customer matches the specified ID.
customer_Isnull	Boolean	Filter for objects where customer is NULL.
useAsTemplate	Boolean	Filter for objects where useAsTemplate matches the specified value.
templateConfiguration_Istartswith	String	Filter for objects where templateConfiguration starts with the specified value (case insensitive).
templateConfiguration_Iexact	String	Filter for objects where templateConfiguration.iexact matches the specified value.
templateConfiguration_In	[String]	Filter for objects where templateConfiguration is contained in the list of specified values.
allowMultipleMarketplaceInstances	Boolean	Filter for objects where allowMultipleMarketplaceInstances matches the specified value.
createdAt_Gte	DateTime	Filter for objects where createdAt occurs on or after the specified value.
createdAt_Lte	DateTime	Filter for objects where createdAt occurs on or before the specified value.
updatedAt_Gte	DateTime	Filter for objects where updatedAt occurs on or after the specified value.
updatedAt_Lte	DateTime	Filter for objects where updatedAt occurs on or before the specified value.
isCodeNative	Boolean	Filter for objects where isCodeNative matches the specified value.
flows_IsAgentFlow	Boolean	Filter for objects where flows.isAgentFlow matches the specified value.
versionSequenceId	UUID	Filter for objects where versionSequenceId matches the specified value.
versionNumber	Int	Filter for objects where versionNumber matches the specified value.
versionIsAvailable	Boolean	Filter for objects where versionIsAvailable matches the specified value.
labels_Contains	String	Filter for objects where labels contains the specified value (case sensitive).
labels_Icontains	String	Filter for objects where labels contains the specified value (case insensitive).
marketplace	Boolean	Filter for objects where marketplace matches the specified value.
allVersions	Boolean	Filter for objects where allVersions matches the specified value.
hasInstances	Boolean	Filter for objects where hasInstances matches the specified value.
hasOutdatedComponents	Boolean	Filter for objects where hasOutdatedComponents matches the specified value.
orderBy	IntegrationOrder	DEPRECATED. 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.

Return fields (IntegrationConnection!)

Field	Type	Description
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.

---

objectPermissionGrant

Returns the specified ObjectPermissionGrant object.

query {
  objectPermissionGrant(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the ObjectPermissionGrant object.

Return fields (ObjectPermissionGrant)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the ObjectPermissionGrant.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the ObjectPermissionGrant.
grantedByRole	Role	The Role through which the Permission is granted, if applicable.
id	ID!	The ID of the object
obj	UUID!	A reference to the object for which the Permission is granted.
permission	Permission!	The Permission being granted.
user	User!	The User for which the Permission is granted.

---

objectPermissionGrants

Returns a Relay Connection to a collection of ObjectPermissionGrant objects.

query {
  objectPermissionGrants {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
user	ID	Filter for objects where user matches the specified ID.
obj	UUID	Filter for objects where obj matches the specified value.
permission	ID	Filter for objects where permission matches the specified ID.
grantedByRole	ID	Filter for objects where grantedByRole matches the specified ID.
orderBy	ObjectPermissionGrantOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[ObjectPermissionGrantOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (ObjectPermissionGrantConnection!)

Field	Type	Description
edges	[ObjectPermissionGrantEdge]!	List of edges containing the nodes in this connection.
nodes	[ObjectPermissionGrant]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

onPremiseResource

Returns the specified OnPremiseResource object.

query {
  onPremiseResource(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the OnPremiseResource object.

Return fields (OnPremiseResource)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the OnPremiseResource.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the OnPremiseResource.
customer	Customer	The Customer associated with this resource.
id	ID!	The ID of the object
name	String!	The name of this resource.
port	Int!	The local port on the proxy service assigned to this resource.
status	OnPremiseResourceStatus!	The current status of this On-Prem Resource.

---

onPremiseResources

Returns a Relay Connection to a collection of OnPremiseResource objects.

query {
  onPremiseResources {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
name	String	Filter for objects where name matches the specified value.
name_Icontains	String	Filter for objects where name contains the specified value (case insensitive).
customer	ID	Filter for objects where customer matches the specified ID.
customer_Isnull	Boolean	Filter for objects where customer is NULL.
status	String	Filter for objects where status matches the specified value.
orderBy	OnPremiseResourceOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[OnPremiseResourceOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (OnPremiseResourceConnection!)

Field	Type	Description
edges	[OnPremiseResourceEdge]!	List of edges containing the nodes in this connection.
nodes	[OnPremiseResource]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

organization

Returns the Organization of the signed-in User if the User is an Organization User.

query {
  organization {
    id
  }
}

Return fields (Organization)

Field	Type	Description
allowAddAlertGroup	Boolean!	Specifies whether the signed-in User can add an AlertGroup to the Organization.
allowAddAlertWebhook	Boolean!	Specifies whether the signed-in User can add an AlertWebhook to the Organization.
allowAddConnectionTemplate	Boolean!	Specifies whether the signed-in User can add a Connection Template to the Organization.
allowAddCredential	Boolean!	DEPRECATED. Specifies whether the signed-in User can add a Credential to the Organization.
allowAddCustomer	Boolean!	Specifies whether the signed-in User can add a Customer to the Organization.
allowAddExternalLogStream	Boolean!	Specifies whether the signed-in User can add an External Log stream to the Organization.
allowAddIntegration	Boolean!	Specifies whether the signed-in User can add an Integration to the Organization.
allowAddScopedConfigVariable	Boolean!	Specifies whether the signed-in User can add a Scoped Config Variable to the Organization.
allowAddSigningKey	Boolean!	Specifies whether the signed-in User can add a Signing Key to the Organization.
allowAddUser	Boolean!	Specifies whether the signed-in User can add a User to the Organization.
allowAddWebhookEndpoint	Boolean!	Specifies whether the signed-in User can add a WebhookEndpoint to the Organization.
allowConfigureCredentials	Boolean!	DEPRECATED. Specifies whether the signed-in User's Organization has access to legacy Credentials.
allowConfigureEmbedded	Boolean!	Specifies whether this Plan allows configuration of Embedded for the Organization.
allowConfigureExternalLogStreams	Boolean!	Specifies whether this Plan allows configuration of External Log Streams for the Organization.
allowConfigureThemes	Boolean!	Specifies whether the signed-in User can configure Themes for the Organization.
allowConfiguringInstanceMemory	Boolean!	Specifies whether this Plan allows for configuring the memory allocated to the Runner Lambda functions.
allowCustomTheme	Boolean!	Specifies whether this Plan allows configuration of a Custom Theme for the Organization.
allowDisablingInstanceOutputs	Boolean!	Specifies whether this Plan allows for disabling Instance logs and step results.
allowEmbeddedDesigner	Boolean!	Specifies whether this Plan allows using the Embedded Designer the Organization.
allowEmbeddedWorkflowBuilder	Boolean!	Specifies whether this Plan allows using the Embedded Workflow Builder the Organization.
allowEnableInstance	Boolean!	Specifies whether Instances may be enabled based on the utilization allowed by the current Plan.
allowExecuteInstance	Boolean!	Specifies whether Instances may be executed based on the utilization allowed by the current Plan.
allowExecutionRetryConfig	Boolean!	Specifies whether the current Plan allows configuration for automatic retry of Instance executions.
allowLongRunningExecutions	Boolean!	Specifies whether this Plan allows for Long Running Executions.
allowOnPremAgent	Boolean!	Specifies whether this Plan allows for using the On Prem Agent system.
allowPublishComponent	Boolean!	Specifies whether the signed-in User can add a Component to the Organization.
allowRemove	Boolean!	Specifies whether the signed-in User can remove the Organization.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the Organization.
allowUserLevelConfig	Boolean!	Specifies whether this Plan allows for creating User Level Configured Instances.
allowViewBilling	Boolean!	Specifies whether the signed-in User can view Billing information for the Organization.
avatarUrl	String	The URL for the avatar image.
brandedElements	JSONString	Specifies custom names for branded elements.
components	ComponentConnection!	The Components that belong to the Organization.
concurrentExecutionLimit	Int!	The maximum number of concurrent executions allowed for this Organization.
concurrentLreLimit	Int!	Maximum number of concurrent long running executions allowed for this Organization.
credentials	CredentialConnection!	The Organization the Credential belongs to, if any. If NULL then Customer will be specified.
currentPlan	String!	Plan the Organization is subscribed to; set once payment is confirmed.
customers	CustomerConnection!	The Organization to which the Customer belongs.
featureFlags	JSONString
id	ID!	The ID of the object
instanceBillingTypes	[String]!	The available billing types for Instances in the Organization.
integrations	IntegrationConnection!	The Integrations that belong to the Organization.
labels	[String!]	The labels that are associated with the object.
marketplaceName	String	DEPRECATED. Display name of the Organization's Marketplace.
name	String!	The unique name of the Organization.
overExecutionLimit	Boolean!	Specifies whether the Organization execution utilization has exceeded the Plan's limits.
overdue	Boolean!	This field has been deprecated.
planExpiresAt	DateTime	Date and time the Organization's current Plan expires
signingKeys	OrganizationSigningKeyConnection!
systemSuspended	Boolean!	Specifies whether the Organization's account has been suspended by Prismatic.
theme	Theme	The Theme associated with an Organization
users	UserConnection!	The Organization that the User belongs to, if any. If this is NULL then Customer will be specified.
usesBillingPortal	Boolean!	This field has been deprecated.

---

organizationRoles

Returns a list of Organization Role objects.

query {
  organizationRoles {
    id
  }
}

Return fields ([Role]!)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the Role.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the Role.
description	String!	Description of the Role.
id	ID!	The ID of the object
level	Int!	An integer that specifies the level of privilege with respect to other Roles.
name	String!	The name of the Role. Must be unique within the context of the AuthObjectType.
objType	AuthObjectType!	The type of object that the Role is associated with.
permissions	PermissionConnection!	List of Permissions that the Role provides.

---

orgDailyUsageMetric

Returns the specified OrgDailyUsageMetrics object.

query {
  orgDailyUsageMetric(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the OrgDailyUsageMetrics object.

Return fields (OrgDailyUsageMetrics)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the OrgDailyUsageMetrics.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the OrgDailyUsageMetrics.
failedExecutionCount	BigInt!	The total number of failed Instance executions on the snapshot date.
id	ID!	The ID of the object
snapshotDate	Date!	The date the utilization metrics snapshot was created.
spendMbSecs	BigInt!	The total execution spend on the snapshot date in MB-secs.
stepCount	BigInt!	The total number of steps executed on the snapshot date.
successfulExecutionCount	BigInt!	The total number of successful Instance executions on the snapshot date.

---

orgDailyUsageMetrics

Returns a Relay Connection to a collection of OrgDailyUsageMetrics objects.

query {
  orgDailyUsageMetrics {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
snapshotDate_Gte	Date	Filter for objects where snapshotDate occurs on or after the specified value.
snapshotDate_Lte	Date	Filter for objects where snapshotDate occurs on or before the specified value.
snapshotDate	Date	Filter for objects where snapshotDate matches the specified value.
orderBy	OrgDailyUsageMetricsOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[OrgDailyUsageMetricsOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (OrgDailyUsageMetricsConnection!)

Field	Type	Description
edges	[OrgDailyUsageMetricsEdge]!	List of edges containing the nodes in this connection.
nodes	[OrgDailyUsageMetrics]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

orgTotalUsageMetric

Returns the specified OrgTotalUsageMetrics object.

query {
  orgTotalUsageMetric(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the OrgTotalUsageMetrics object.

Return fields (OrgTotalUsageMetrics)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the OrgTotalUsageMetrics.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the OrgTotalUsageMetrics.
blobBytesStored	BigInt!	The total number of bytes of blob storage currently used.
customerCount	Int!	The total number of Customers that currently exist.
deployedInstanceCount	Int!	The total number of Instances that are deployed.
deployedUniqueIntegrationCount	Int!	The total number of unique Integrations that are deployed.
id	ID!	The ID of the object
integrationCount	Int!	The total number of Integrations that currently exist.
snapshotTime	DateTime!	The time the utilization metrics snapshot was created.
userCount	Int!	The total number of Users that currently exist.

---

orgTotalUsageMetrics

Returns a Relay Connection to a collection of OrgTotalUsageMetrics objects.

query {
  orgTotalUsageMetrics {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
onlyLatestDailySnapshots	Boolean	Specifies whether to only return the latest snapshot record for each day.
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
snapshotTime_Gte	DateTime	Filter for objects where snapshotTime occurs on or after the specified value.
snapshotTime_Lte	DateTime	Filter for objects where snapshotTime occurs on or before the specified value.
orderBy	OrgTotalUsageMetricsOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[OrgTotalUsageMetricsOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (OrgTotalUsageMetricsConnection!)

Field	Type	Description
edges	[OrgTotalUsageMetricsEdge]!	List of edges containing the nodes in this connection.
nodes	[OrgTotalUsageMetrics]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

permission

Returns the specified Permission object.

query {
  permission(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the Permission object.

Return fields (Permission)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the Permission.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the Permission.
description	String!	Description of the Permission.
id	ID!	The ID of the object
name	String!	Name of the Permission.
objType	AuthObjectType!	The type of object that the Permission is associated with.
tag	String!	A unique string identity value.

---

permissions

Returns a Relay Connection to a collection of Permission objects.

query {
  permissions {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
name	String	Filter for objects where name matches the specified value.
objType	ID	Filter for objects where objType matches the specified ID.
orderBy	PermissionOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[PermissionOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (PermissionConnection!)

Field	Type	Description
edges	[PermissionEdge]!	List of edges containing the nodes in this connection.
nodes	[Permission]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

reusableConnections

Query for reusableConnections.

query {
  reusableConnections {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String
after	String
first	Int
last	Int
stableKey	String
stableKey_In	String
variableScope	String
managedBy	String
description_Icontains	String
includeCustomer	Boolean
id_In	ID
key	String
key_Isnull	Boolean
key_Icontains	String
customer	ID
isTest	Boolean
scopedConfigVariable	ID
scopedConfigVariable_StableKey	String
scopedConfigVariable_StableKey_Icontains	String
scopedConfigVariable_Key	String
scopedConfigVariable_Key_Icontains	String
scopedConfigVariable_VariableScope	String
scopedConfigVariable_ManagedBy	String
status	String
status_In	String
connection_Component_In	[ComponentSelector]
connection_Component_Label_Icontains	String
sortBy	[ReusableConnectionOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (ReusableConnectionConnection)

Field	Type	Description
edges	[ReusableConnectionEdge]!	List of edges containing the nodes in this connection.
nodes	[ReusableConnection]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

scopedConfigVariable

Returns the specified ScopedConfigVariable object.

query {
  scopedConfigVariable(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the ScopedConfigVariable object.

Return fields (ScopedConfigVariable)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the ScopedConfigVariable.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the ScopedConfigVariable.
authorizeUrl	String	The Authorize URL of this Config Variable if associated with an OAuth 2.0 Connection.
connection	Connection	The Connection to which this variable is associated.
customer	Customer	The Customer with which this Config Variable is associated.
customerConfigVariables	CustomerConfigVariableConnection!	The Scoped Config Variable with which this Config Variable is associated.
customers	CustomerConnection!	Returns a list of Customers using this config variable.
defaultForComponent	Boolean!	Specifies whether this Config Variable is required for Customers using the related Component.
description	String	Additional notes about the Scoped Config Variable.
hasDeployedInstances	Boolean!	Indicates this config variable is in use on an Instance.
id	ID!	The ID of the object
inputs	ExpressionConnection	The collection of Expressions that serve as inputs to this variable.
instances	InstanceConnection!	Returns a list of Instances of Integrations using this config variable.
integrations	IntegrationConnection!	Returns a list of Integrations using this config variable.
isInUse	Boolean!	Indicates that this config variable is currently in use by at least one Instance or Integration version.
key	String!	The display name of this variable.
lastConfiguredAt	DateTime	The timestamp of the most recent inputs reconfiguration.
lastSuccessfulRefreshAt	DateTime	The timestamp of the last successful OAuth2 token refresh.
logs	LogConnection!	The ScopedConfigVariable which relates to the Log entry.
managedBy	ScopedConfigVariableManagedBy!	Enforces which group of users can modify the variable.
meta	JSONString	Contains arbitrary metadata about this variable.
oAuthRedirectConfig	OAuthRedirectConfig	Configuration for OAuth custom redirects.
refreshAt	DateTime	The timestamp at which the OAuth2 token will automatically be refreshed, if necessary. Only applies to OAuth2 methods where refresh is necessary.
requiredConfigVariables	RequiredConfigVariableConnection!	Scoped Config Variable providing configuration for this Required Config Variable.
stableKey	String!	The stable key for referencing this variable from Integrations. Cannot change after setting.
status	ScopedConfigVariableStatus	Status indicating if this Connection is working as expected or encountering issues.
variableScope	ScopedConfigVariableVariableScope!	Specifies the scope of the variable.
workflows	WorkflowConnection!	Returns a list of Workflows using this config variable.

---

scopedConfigVariables

Returns a Relay Connection to a collection of ScopedConfigVariable objects.

query {
  scopedConfigVariables {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
id_In	[ID]	Filter for objects where id is contained in the list of specified values.
key	String	Filter for objects where key matches the specified value.
key_Icontains	String	Filter for objects where key contains the specified value (case insensitive).
stableKey	String	Filter for objects where stableKey matches the specified value.
stableKey_In	[String]	Filter for objects where stableKey is contained in the list of specified values.
variableScope	String	Filter for objects where variableScope matches the specified value.
managedBy	String	Filter for objects where managedBy matches the specified value.
connection_Component_Label_Icontains	String	Filter for objects where connection.component.label contains the specified value (case insensitive).
description_Icontains	String	Filter for objects where description contains the specified value (case insensitive).
status	String	Filter for objects where status matches the specified value.
status_In	[String]	Filter for objects where status is contained in the list of specified values.
includeCustomer	Boolean	Filter for objects where includeCustomer matches the specified value.
connection_Component_In	[ComponentSelector]	Filter for objects where connection.component is contained in the list of specified values.
orderBy	ScopedConfigVariableOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[ScopedConfigVariableOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (ScopedConfigVariableConnection!)

Field	Type	Description
edges	[ScopedConfigVariableEdge]!	List of edges containing the nodes in this connection.
nodes	[ScopedConfigVariable]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

standardIntegrationTemplate

Returns the specified IntegrationTemplate object.

query {
  standardIntegrationTemplate(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the IntegrationTemplate object.

Return fields (IntegrationTemplate)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the IntegrationTemplate.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the IntegrationTemplate.
category	String!	Specifies the category of the Integration Template.
createdAt	DateTime!	The timestamp at which the object was created.
definition	String!	The YAML representation of the Integration Template.
description	String!	Additional notes about the Integration Template.
iconUrl	String	The URL to the icon for the IntegrationTemplate.
id	ID!	The ID of the object
name	String!	The name of the Integration Template. Must be unique.
updatedAt	DateTime!	The timestamp at which the object was most recently updated.

---

standardIntegrationTemplates

Returns a Relay Connection to a collection of IntegrationTemplate objects.

query {
  standardIntegrationTemplates {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
category	String	Filter for objects where category matches the specified value.
category_Icontains	String	Filter for objects where category contains the specified value (case insensitive).
searchTerms_Fulltext	String	Filter for objects where searchTerms.fulltext matches the specified value.
orderBy	IntegrationTemplateOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[IntegrationTemplateOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (IntegrationTemplateConnection!)

Field	Type	Description
edges	[IntegrationTemplateEdge]!	List of edges containing the nodes in this connection.
nodes	[IntegrationTemplate]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

starredRecord

Returns the specified StarredRecord object.

query {
  starredRecord(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the StarredRecord object.

Return fields (StarredRecord)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the StarredRecord.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the StarredRecord.
description	String
id	ID!	The ID of the object
timestamp	DateTime!	Date/Time when the record was starred
user	User!	User that starred a record

---

starredRecords

Returns a Relay Connection to a collection of StarredRecord objects.

query {
  starredRecords {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
orderBy	StarredRecordOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[StarredRecordOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (StarredRecordConnection!)

Field	Type	Description
edges	[StarredRecordEdge]!	List of edges containing the nodes in this connection.
nodes	[StarredRecord]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

stepResult

Returns the specified InstanceStepResult object.

query {
  stepResult(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the InstanceStepResult object.

Return fields (InstanceStepResult)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the InstanceStepResult.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the InstanceStepResult.
branchName	String	The name of the branch containing the IntegrationAction that generated this result, if any.
componentActionKey	String	A JSON value that contains attributes which uniquely identify the Component Action which generated this result.
displayStepName	String	The display name of the IntegrationAction that generated this result.
endedAt	DateTime	The timestamp at which execution of the step ended.
executionResult	InstanceExecutionResult!	The InstanceExecutionResult to which the InstanceStepResult is associated.
fromPreprocessFlow	Boolean!	Specifies whether the result was generated as part of the associated Integration's Preprocess Flow.
hasError	Boolean!	Specifies whether this step result had an error during execution.
id	ID!	The ID of the object
instance	Instance	The Instance to which the InstanceStepResult is associated.
isLoopStep	Boolean!	Specifies whether the result was generated by a Loop IntegrationAction.
isRootResult	Boolean!	Identifies whether this is a 'root level' result or whether this is contained in a loop.
loopInputsMetadataUrl	String	The presigned URL to fetch metadata of the inputs for this specific step if it is a Loop step.
loopInputsUrl	String	The presigned URL to download the inputs for this specific step if it is a Loop step.
loopPath	String	A string containing a sequence of space-separated 'loopStepName:iterationNumber' tokens that allow this result to be requested based solely on loop positions and iteration numbers
loopStepIndex	Int	The iteration index of the containing Loop IntegrationAction at the time this result was generated, if any.
loopStepName	String	The name of the IntegrationAction that is the Loop containing the IntegrationAction that generated this result, if any.
resultsMetadataUrl	String!	The presigned URL to fetch metadata of the result of this specific step of the Instance execution.
resultsUrl	String!	The presigned URL to download the result of this specific step of the Instance execution.
startedAt	DateTime!	The timestamp at which execution of the step started.
stepName	String	The name of the IntegrationAction that generated this result.
stepStableKey	String	The stable key of the IntegrationAction that generated this result.

---

stepResults

Returns a Relay Connection to a collection of InstanceStepResult objects.

query {
  stepResults {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
executionResult	ID	Filter for objects where executionResult matches the specified ID.
instance	ID	Filter for objects where instance matches the specified ID.
startedAt_Gte	DateTime	Filter for objects where startedAt occurs on or after the specified value.
startedAt_Lte	DateTime	Filter for objects where startedAt occurs on or before the specified value.
endedAt_Gte	DateTime	Filter for objects where endedAt occurs on or after the specified value.
endedAt_Lte	DateTime	Filter for objects where endedAt occurs on or before the specified value.
stepName	String	Filter for objects where stepName matches the specified value.
displayStepName	String	Filter for objects where displayStepName matches the specified value.
isLoopStep	Boolean	Filter for objects where isLoopStep matches the specified value.
loopStepName	String	Filter for objects where loopStepName matches the specified value.
loopStepIndex	Int	Filter for objects where loopStepIndex matches the specified value.
loopPath	String	Filter for objects where loopPath matches the specified value.
loopPath_Istartswith	String	Filter for objects where loopPath starts with the specified value (case insensitive).
isRootResult	Boolean	Filter for objects where isRootResult matches the specified value.
branchName	String	Filter for objects where branchName matches the specified value.
hasError	Boolean	Filter for objects where hasError matches the specified value.
fromPreprocessFlow	Boolean	Filter for objects where fromPreprocessFlow matches the specified value.
orderBy	InstanceStepResultOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[InstanceStepResultOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (InstanceStepResultConnection!)

Field	Type	Description
edges	[InstanceStepResultEdge]!	List of edges containing the nodes in this connection.
nodes	[InstanceStepResult]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

testCase

Returns the specified TestCase object.

query {
  testCase(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the TestCase object.

Return fields (TestCase)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the TestCase.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the TestCase.
contentType	String	Content type of the test payload.
createdAt	DateTime!	The timestamp at which the object was created.
flow	IntegrationFlow	The IntegrationFlow this TestCase belongs to.
headers	JSONString	Test headers as key/value pairs.
id	ID!	The ID of the object
integration	Integration!	The Integration this TestCase belongs to.
name	String!	The name of the TestCase.
payload	String	Test step payload data.
result	JSONString	Test step result data.
updatedAt	DateTime!	The timestamp at which the object was most recently updated.

---

testCases

Returns a Relay Connection to a collection of TestCase objects.

query {
  testCases {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
integration	ID	Filter for objects where integration matches the specified ID.
flow	ID	Filter for objects where flow matches the specified ID.

Return fields (TestCaseConnection!)

Field	Type	Description
edges	[TestCaseEdge]!	List of edges containing the nodes in this connection.
nodes	[TestCase]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

theme

Returns the Organization Theme of the signed-in User.

query {
  theme {
    id
  }
}

Return fields (Theme)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the Theme.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the Theme.
colors	ThemeColorConnection!	The Theme the Color is associated with.
id	ID!	The ID of the object
properties	ThemePropertyConnection!	The Theme the Property is associated with.

---

uploadMedia

Returns a pre-signed URL for uploading the specified media file.

query {
  uploadMedia(objectId: "example-id", fileName: "example", mediaType: {}) {
    id
  }
}

Input fields

Argument	Type	Description
objectId	ID!	The ID of the object with which to associate the media file.
fileName	String!	The name of the media file.
mediaType	MediaType!	The relationship of the media file to the object.

Return fields (UploadMedia!)

Field	Type	Description
contentType	String	The content type (MIME type) that must be used when uploading the file.
error	String	Contains any error message that occurred as part of generating the pre-signed URL.
objectUrl	String	The URL where the file is located after being uploaded.
uploadUrl	String	The pre-signed URL to which the file should be uploaded.

---

user

Returns the specified User object.

query {
  user(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the User object.

Return fields (User)

Field	Type	Description
allowChangeRoles	Boolean!	Specifies whether the signed-in User can change the Role of the User.
allowRemove	Boolean!	Specifies whether the signed-in User can remove the User.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the User.
appAvatarUrl	String	The URL for the main avatar image that is displayed in Prismatic.
appName	String!	The app name displayed in Prismatic.
avatarUrl	String	The URL for the avatar image.
createdAt	DateTime!	The timestamp at which the object was created.
customer	Customer	The Customer the user belongs to, if any. If this is NULL then Organization will be specified.
darkMode	Boolean!	Designates whether the User has dark mode activated or not.
darkModeSyncWithOs	Boolean!	Designates whether dark mode should be derived from the operating system.
dateJoined	DateTime!	The date the User was created.
email	String!	The email address associated with the User.
externalId	String	Allows for mapping an external entity to a Prismatic record.
featureFlags	JSONString!
hideSensitiveCustomerDataEnabled	Boolean!	Specifies whether sensitive customer data hiding is enabled for this user's organization. When True, sensitive data (step outputs, logs, execution results, and connection inputs) is hidden from view. Customer users always have this set to False as they can always see their own data.
id	ID!	The ID of the object
marketplaceName	String!	The name displayed for the Marketplace.
name	String!	The user's preferred name.
org	Organization	The Organization that the User belongs to, if any. If this is NULL then Customer will be specified.
phone	String!	The preferred contact phone number for the User.
role	Role!	The Role associated with the User which determines its permissions.
tenantId	String!	The unique identifier for the tenant this user belongs to.
updatedAt	DateTime!	The timestamp at which the object was most recently updated.

---

userExists

Returns whether a User exists with the specified email address.

query {
  userExists(email: "example") {
    id
  }
}

Input fields

Argument	Type	Description
email	String!	The email address to check.

Return type: Boolean

---

userFlows

Query for userFlows.

query {
  userFlows {
    nodes {
          id
        }
  }
}

Return fields (UserFlowConnection)

Field	Type	Description
edges	[UserFlowEdge]!	List of edges containing the nodes in this connection.
nodes	[UserFlow]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

users

Returns a Relay Connection to a collection of User objects.

query {
  users {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
name	String	Filter for objects where name matches the specified value.
name_Icontains	String	Filter for objects where name contains the specified value (case insensitive).
email	String	Filter for objects where email matches the specified value.
email_Icontains	String	Filter for objects where email contains the specified value (case insensitive).
customer	ID	Filter for objects where customer matches the specified ID.
customer_Isnull	Boolean	Filter for objects where customer is NULL.
createdAt_Gte	DateTime	Filter for objects where createdAt occurs on or after the specified value.
createdAt_Lte	DateTime	Filter for objects where createdAt occurs on or before the specified value.
updatedAt_Gte	DateTime	Filter for objects where updatedAt occurs on or after the specified value.
updatedAt_Lte	DateTime	Filter for objects where updatedAt occurs on or before the specified value.
externalId	String	Filter for objects where externalId matches the specified value.
externalId_Isnull	Boolean	Filter for objects where externalId is NULL.
includeMarketplaceUsers	Boolean	Filter for objects where includeMarketplaceUsers matches the specified value.
orderBy	UserOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[UserOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (UserConnection!)

Field	Type	Description
edges	[UserEdge]!	List of edges containing the nodes in this connection.
nodes	[User]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

webhookEndpoint

Returns the specified WebhookEndpoint object.

query {
  webhookEndpoint(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the WebhookEndpoint object.

Return fields (WebhookEndpoint)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the WebhookEndpoint.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the WebhookEndpoint.
createdAt	DateTime!	The timestamp at which the object was created.
description	String	Additional notes about this webhook endpoint configuration.
enabled	Boolean!	Whether this webhook endpoint is currently enabled. Disabled endpoints will not receive events.
eventTypes	[String!]!	List of event types this webhook endpoint subscribes to. Must include at least one event type.
headers	JSONString	A JSON object of key/value pairs that will be sent as headers with each webhook request.
id	ID!	The ID of the object
name	String!	Friendly name for the webhook endpoint.
secret	String	Secret key used for HMAC signature generation. If provided, all webhook payloads will include an X-Webhook-Signature header.
updatedAt	DateTime!	The timestamp at which the object was most recently updated.
url	String!	The URL where webhook events will be sent.

---

webhookEndpoints

Returns a Relay Connection to a collection of WebhookEndpoint objects.

query {
  webhookEndpoints {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
name_Icontains	String	Filter for objects where name contains the specified value (case insensitive).
enabled	Boolean	Filter for objects where enabled matches the specified value.
createdAt_Gte	DateTime	Filter for objects where createdAt occurs on or after the specified value.
createdAt_Lte	DateTime	Filter for objects where createdAt occurs on or before the specified value.
updatedAt_Gte	DateTime	Filter for objects where updatedAt occurs on or after the specified value.
updatedAt_Lte	DateTime	Filter for objects where updatedAt occurs on or before the specified value.
orderBy	WebhookEndpointOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[WebhookEndpointOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (WebhookEndpointConnection!)

Field	Type	Description
edges	[WebhookEndpointEdge]!	List of edges containing the nodes in this connection.
nodes	[WebhookEndpoint]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

webhookEventTypes

List of all available webhook event types with id and name pairs.

query {
  webhookEventTypes {
    id
  }
}

Return fields ([WebhookEventTypeInfo]!)

Field	Type	Description
id	String!	The event type identifier (e.g., 'log_stream.updated', 'user.deleted').
name	String!	The human-readable event name (e.g., 'Log Stream Updated', 'User Deleted').

---

workflow

Returns the specified Workflow object.

query {
  workflow(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the Workflow object.

Return fields (Workflow)

Field	Type	Description
actions	WorkflowActionConnection!	The individual actions within this Workflow.
allowRemove	Boolean!	Specifies whether the signed-in User can remove the Workflow.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the Workflow.
category	String	Specifies the category of the Integration.
components	ComponentConnection!	Components associated with this Workflow.
createdAt	DateTime!	The timestamp at which the object was created.
customer	Customer	The Customer that this Workflow belongs to.
customerConfigVariables	CustomerConfigVariableConnection!	Returns a list of Customer Config Variables associated with this Workflow.
definition	String	The YAML that is the declarative definition for the Integration that backs this Workflow.
deployedVersion	Workflow	The deployed version of this Workflow.
description	String	Additional notes about the Workflow.
documentation	String	Rich text documentation to accompany the Workflow.
enablementBlockers	[EnablementBlocker]!	List of reasons preventing this Workflow from being enabled.
flow	WorkflowFlow!	The singular Flow that represents the Workflow.
hasUnpublishedChanges	Boolean!	Specifies whether the Workflow definition has changes that have not yet been published.
id	ID!	The ID of the object
instance	Instance	The singular Instance that runs this Workflow.
labels	[String!]	The labels that are associated with the object.
lastExecutedAt	DateTime	The timestamp at which this Workflow was most recently executed.
metadata	JSONString	A JSON string that represents metadata about the Workflow.
name	String!	The name of the Workflow.
scopedConfigVariables	ScopedConfigVariableConnection!	Returns a list of Scoped Config Variables associated with this Workflow.
starred	Boolean	Indicates whether the record is starred by the signed-in User.
systemInstance	Instance!	System Instance backing this Workflow.
template	WorkflowTemplate	The WorkflowTemplate associated with this Workflow, if any.
testCases	TestCaseConnection!	Test cases associated with this Workflow, if any.
updatedAt	DateTime!	The timestamp at which the object was most recently updated.
validationRules	IntegrationValidationRules!	Validation Rules applied to this Workflow.
versionAt	Workflow	Object data at specified version
versionAttributes	JSONString	Additional attributes that are specific to this version.
versionComment	String	Additional comments about this version.
versionCreatedAt	DateTime	Timestamp of the creation of this version.
versionCreatedBy	User	User that created this version.
versionIsAvailable	Boolean!	Indicates if the version is available for use.
versionIsLatest	Boolean!	Marked if this record is the latest version of this sequence.
versionNumber	Int!	Sequential number identifying this version.
versionSequence	WorkflowConnection	Sequence of versions of this Workflow.
versionSequenceId	UUID	Identifier for this version sequence.

---

workflowCategories

Returns a list of Workflow categories.

query {
  workflowCategories {
    id
  }
}

Input fields

Argument	Type	Description
onlyLatest	Boolean	Only include categories that appear on the latest versions of Integrations.
onlyPublished	Boolean	Only include categories that appear on published versions of Integrations.
fromTemplates	Boolean	Include categories defined by templates.

Return fields ([IntegrationCategory]!)

Field	Type	Description
id	ID!	The ID of the object
name	String!	The name of the Integration category.

---

workflowLabels

Returns a list of unique Workflow labels.

query {
  workflowLabels {
    id
  }
}

Input fields

Argument	Type	Description
onlyLatest	Boolean	Only include labels that appear on the latest versions of Workflows.
onlyPublished	Boolean	Only include labels that appear on published versions of Workflows.
fromTemplates	Boolean	Include labels defined by templates.

Return fields ([Label]!)

Field	Type	Description
id	ID!	The ID of the object
name	String!	The value of the label.

---

workflows

Returns a Relay Connection to a collection of Workflow objects.

query {
  workflows {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
name	String	Filter for objects where name matches the specified value.
name_Icontains	String	Filter for objects where name contains the specified value (case insensitive).
description	String	Filter for objects where description matches the specified value.
description_Icontains	String	Filter for objects where description contains the specified value (case insensitive).
customer	ID	Filter for objects where customer matches the specified ID.
customer_Isnull	Boolean	Filter for objects where customer is NULL.
createdAt_Gte	DateTime	Filter for objects where createdAt occurs on or after the specified value.
createdAt_Lte	DateTime	Filter for objects where createdAt occurs on or before the specified value.
updatedAt_Gte	DateTime	Filter for objects where updatedAt occurs on or after the specified value.
updatedAt_Lte	DateTime	Filter for objects where updatedAt occurs on or before the specified value.
category	String	Filter for objects where category matches the specified value.
category_Icontains	String	Filter for objects where category contains the specified value (case insensitive).
versionSequenceId	UUID	Filter for objects where versionSequenceId matches the specified value.
versionNumber	Int	Filter for objects where versionNumber matches the specified value.
versionIsAvailable	Boolean	Filter for objects where versionIsAvailable matches the specified value.
labels_Contains	String	Filter for objects where labels contains the specified value (case sensitive).
labels_Icontains	String	Filter for objects where labels contains the specified value (case insensitive).
draft	Boolean	Filter for objects where draft matches the specified value.
allVersions	Boolean	Filter for objects where allVersions matches the specified value.
orderBy	WorkflowOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[WorkflowOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (WorkflowConnection!)

Field	Type	Description
edges	[WorkflowEdge]!	List of edges containing the nodes in this connection.
nodes	[Workflow]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.

---

workflowTemplate

Returns the specified WorkflowTemplate object.

query {
  workflowTemplate(id: "example-id") {
    id
  }
}

Input fields

Argument	Type	Description
id	ID!	The ID of the WorkflowTemplate object.

Return fields (WorkflowTemplate)

Field	Type	Description
allowRemove	Boolean!	Specifies whether the signed-in User can remove the WorkflowTemplate.
allowUpdate	Boolean!	Specifies whether the signed-in User can update the WorkflowTemplate.
category	String!	Specifies the category of the Integration Template.
createdAt	DateTime!	The timestamp at which the object was created.
definition	String!	The YAML representation of the Integration Template.
description	String!	Additional notes about the Integration Template.
id	ID!	The ID of the object
labels	[String!]	The labels that are associated with the object.
name	String!	The name of the Integration Template. Must be unique.
updatedAt	DateTime!	The timestamp at which the object was most recently updated.
workflow	Workflow	The Workflow in which this action resides.

---

workflowTemplates

Returns a Relay Connection to a collection of WorkflowTemplate objects.

query {
  workflowTemplates {
    nodes {
          id
        }
  }
}

Input fields

Argument	Type	Description
before	String	Specifies a cursor for use in combination with last to implement backward pagination.
after	String	Specifies a cursor for use in combination with first to implement forward pagination.
first	Int	A non-negative integer that specifies to return at most first edges after the after cursor.
last	Int	A non-negative integer that specifies to return at most last edges before the before cursor.
offset	Int
searchTerms_Fulltext	String	Filter for objects where searchTerms.fulltext matches the specified value.
category	String	Filter for objects where category matches the specified value.
category_Icontains	String	Filter for objects where category contains the specified value (case insensitive).
labels_Icontains	String	Filter for objects where labels contains the specified value (case insensitive).
labels_Contains	String	Filter for objects where labels contains the specified value (case sensitive).
orderBy	WorkflowTemplateOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[WorkflowTemplateOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (WorkflowTemplateConnection!)

Field	Type	Description
edges	[WorkflowTemplateEdge]!	List of edges containing the nodes in this connection.
nodes	[WorkflowTemplate]!	List of nodes in this connection.
pageInfo	PageInfo!	Pagination data for this connection.
totalCount	Int!	Total count of nodes available.