users Query

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

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
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).
email	String	Filter for objects where email matches the specified value.
email_Icontains	String	Filter for objects where email contains the specified value (case insensitive).
customer	ID	Filter for objects where customer matches the specified ID.
customer_Isnull	Boolean	Filter for objects where customer is NULL.
createdAt_Gte	DateTime	Filter for objects where createdAt occurs on or after the specified value.
createdAt_Lte	DateTime	Filter for objects where createdAt occurs on or before the specified value.
updatedAt_Gte	DateTime	Filter for objects where updatedAt occurs on or after the specified value.
updatedAt_Lte	DateTime	Filter for objects where updatedAt occurs on or before the specified value.
externalId	String	Filter for objects where externalId matches the specified value.
externalId_Isnull	Boolean	Filter for objects where externalId is NULL.
orderBy	UserOrder	DEPRECATED. Prefer using sort_by instead as it allows ordering by many fields.
sortBy	[UserOrder]	Allows specifying many field and direction pairs to sort results by.

Return fields (UserConnection!)

edges ([UserEdge]!)

List of edges containing the nodes in this connection.

nodes ([User]!)

List of nodes in this connection.

pageInfo (PageInfo!)

Pagination data for this connection.

totalCount (Int!)

Total count of nodes available.