customers

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].

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.
orderByCustomerOrderAllows specifying which field and direction to order by.
nameStringFilter for objects where name matches the specified value.
name_IcontainsStringFilter for objects where name contains the specified value (case insensitive).
name_IstartswithStringFilter for objects where name starts with the specified value (case insensitive).
description_IcontainsStringFilter for objects where description contains the specified value (case insensitive).
isSystemBooleanFilter for objects where isSystem matches the specified value.
labels_ContainsStringFilter for objects where labels contains the specified value (case sensitive).

Return fields (CustomerConnection!)

pageInfo (PageInfo!)

Pagination data for this connection.

nodes ([Customer]!)

List of nodes in this connection.

edges ([CustomerEdge]!)

List of edges containing the nodes in this connection.

totalCount (Int!)

Total count of nodes available.

Last updated on