Skip to main content

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

ArgumentTypeDescription
allVersionsBooleanReturn all versions instead of only the latest
hasTriggersBooleanReturn only Components that have Triggers
hasCommonTriggersBooleanReturn only Components that have commonly-used Triggers
hasActionsBooleanReturn only Components that have Actions
hasConnectionsBooleanReturn only Components that have Connections
hasConnectionTemplatesBooleanReturn only Components that have at least one Connection that's templated
hasDataSourcesBooleanReturn only Components that have Data Sources
hasDataSourcesOfTypeStringReturn only Components that have Data Sources of the specified type.
filterQueryJSONStringJSON structure defining a conditional logic expression tree to use for including specific Actions.
includeComponentsForCodeNativeIntegrationsBooleanInclude Components that are for Code Native Integrations in addition to normal Components.
beforeStringSpecifies a cursor for use in combination with last to implement backward pagination.
afterStringSpecifies a cursor for use in combination with first to implement forward pagination.
firstIntA non-negative integer that specifies to return at most first edges after the after cursor.
lastIntA non-negative integer that specifies to return at most last edges before the before cursor.
offsetInt
label_IcontainsStringFilter for objects where label contains the specified value (case insensitive).
description_IcontainsStringFilter for objects where description contains the specified value (case insensitive).
keyStringFilter for objects where key matches the specified value.
key_IcontainsStringFilter 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.
categoryStringFilter for objects where category matches the specified value.
searchTerms_IcontainsStringFilter for objects where searchTerms contains the specified value (case insensitive).
searchTerms_FulltextStringFilter for objects where searchTerms.fulltext matches the specified value.
publicBooleanFilter for objects where public matches the specified value.
customerIDFilter for objects where customer matches the specified ID.
customer_IsnullBooleanFilter for objects where customer is NULL.
versionCreatedAt_GteDateTimeFilter for objects where versionCreatedAt occurs on or after the specified value.
versionCreatedAt_LteDateTimeFilter for objects where versionCreatedAt occurs on or before the specified value.
versionSequenceIdUUIDFilter for objects where versionSequenceId matches the specified value.
versionNumberIntFilter for objects where versionNumber matches the specified value.
versionIsAvailableBooleanFilter for objects where versionIsAvailable matches the specified value.
labels_IcontainsStringFilter for objects where labels contains the specified value (case insensitive).
labels_ContainsStringFilter for objects where labels contains the specified value (case sensitive).
orderByComponentOrderDEPRECATED. 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.