users

Returns a Relay Connection to a collection of User objects.

Access is permitted when any of the following condition(s) are met: 1. The specified object is the signed-in User. 2. The signed-in User has any of the following permissions for the associated Organization: [org_admin_users, org_view_users]. 3. The signed-in User has any of the following permissions for the associated Organization: [org_admin_customer_permissions, org_manage_customers, org_view_customers]. 4. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_admin_users, customer_view_users].

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.
orderByUserOrderAllows specifying which field and direction to order by.
name_IcontainsStringFilter for objects where name contains the specified value (case insensitive).
email_IcontainsStringFilter for objects where email contains the specified value (case insensitive).
customerIDFilter for objects where customer matches the specified ID.
customer_IsnullBooleanFilter for objects where customer is NULL.

Return fields (UserConnection!)

pageInfo (PageInfo!)

Pagination data for this connection.

nodes ([User]!)

List of nodes in this connection.

edges ([UserEdge]!)

List of edges containing the nodes in this connection.

totalCount (Int!)

Total count of nodes available.

Last updated on