Skip to main content

customerConfigVariables Query

Returns a Relay Connection to a collection of CustomerConfigVariable 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_manage_integrations, org_manage_customers]. 2. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_manage_integrations].

Input fields

ArgumentTypeDescription
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
id_In[ID]Filter for objects where id is contained in the list of specified values.
keyStringFilter for objects where key matches the specified value.
key_IsnullBooleanFilter for objects where key is NULL.
key_IcontainsStringFilter for objects where key contains the specified value (case insensitive).
customerIDFilter for objects where customer matches the specified ID.
isTestBooleanFilter for objects where isTest matches the specified value.
scopedConfigVariableIDFilter for objects where scopedConfigVariable matches the specified ID.
scopedConfigVariable_StableKeyStringFilter for objects where scopedConfigVariable.stableKey matches the specified value.
scopedConfigVariable_StableKey_IcontainsStringFilter for objects where scopedConfigVariable.stableKey contains the specified value (case insensitive).
scopedConfigVariable_KeyStringFilter for objects where scopedConfigVariable.key matches the specified value.
scopedConfigVariable_Key_IcontainsStringFilter for objects where scopedConfigVariable.key contains the specified value (case insensitive).
scopedConfigVariable_VariableScopeStringFilter for objects where scopedConfigVariable.variableScope matches the specified value.
scopedConfigVariable_ManagedByStringFilter for objects where scopedConfigVariable.managedBy matches the specified value.
statusStringFilter 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_IcontainsStringFilter for objects where connection.component.label contains the specified value (case insensitive).
orderByCustomerConfigVariableOrderDEPRECATED. 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!)

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.