users

Returns users of the instance. Soft deleted users are included only when filtering by deleted_at.

users(
  filter: UsersFilterInput
  options: QueryOptionsInput
  page: Int = 1
  per_page: Int!
  sort: [UsersSortInput!]
): UserCollection!

Arguments

filter (UsersFilterInput)

Conditions the returned results must match. All conditions are combined with AND

options (QueryOptionsInput)

Per-query execution options, such as reading from the read replica or a custom database timeout

page (Int)

Page number to return, starting at 1. Requesting a page beyond the last one returns an empty results list

per_page (Int)

Number of results per page, must be greater than 0

sort (UsersSortInput)

Sort order of the results. When several entries are given, they are applied
in the given order. Results are additionally sorted by id ascending unless
id (or random) is part of the sort

Type

UserCollection

Paginated list of users