customers Query

Returns a Relay Connection to a collection of Customer 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_customer_permissions, org_manage_customers, org_view_customers]. 2. The signed-in User has any of the following permissions for the object: [customer_view, customer_edit, customer_remove, customer_admin_users, customer_view_users, customer_admin_instance_permissions, customer_view_instances, customer_manage_marketplace_integrations, customer_access_marketplace_integrations].

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`	`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.
`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).
`isSystem`	`Boolean`	Filter for objects where isSystem matches the specified value.
`allowEmbeddedDesigner`	`Boolean`	Filter for objects where allowEmbeddedDesigner matches 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).

Return fields (CustomerConnection!)#

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.