instances Query

Returns a Relay Connection to a collection of Instance objects.

Access is permitted when any of the following condition(s) are met: 1. The signed-in User has any of the following permissions for the associated Organization: [org_admin_instance_permissions, org_manage_instances, org_view_instances]. 2. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_admin_instance_permissions, customer_view_instances]. 3. The signed-in User has any of the following permissions for the object: [instance_admin_permissions, instance_view, instance_edit, instance_remove]. 4. The signed-in User has any of the following permissions for the associated Customer: [customer_view_marketplace_integrations].

Input fields

Argument	Type	Description
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
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.
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.
isSystem	Boolean	Filter for objects where isSystem matches the specified value.
needsDeploy	Boolean	Filter for objects where needsDeploy matches the specified value.
labels_Icontains	String	Filter for objects where labels contains the specified value (case insensitive).

Return fields (InstanceConnection!)

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.