components Query

Returns a Relay Connection to a collection of Component objects.

Access is permitted when any of the following condition(s) are met: 1. The object's 'public' attribute equals: True. 2. The signed-in User has any of the following permissions for the associated Organization: [org_admin_component_permissions, org_manage_components, org_view_components]. 3. The signed-in User has any of the following permissions for any version of the object: [component_view, component_edit, component_remove, component_admin_permissions, component_publish_new_version]. 4. The signed-in User has any of the following permissions for the associated Customer: [customer_view_org_components].

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
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!)

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.