> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/graphql-api/queries/users.md).

# Users

Users Query

Returns a paginated list of User objects, with optional filtering and ordering. Users represent people who can access and interact with the pyck system.

## Arguments

| Name      | Type             | Description                                                            |
| --------- | ---------------- | ---------------------------------------------------------------------- |
| `after`   | `Cursor`         | Returns the elements in the list that come after the specified cursor  |
| `first`   | `Int`            | Returns the first *n* elements from the list                           |
| `before`  | `Cursor`         | Returns the elements in the list that come before the specified cursor |
| `last`    | `Int`            | Returns the last *n* elements from the list                            |
| `orderBy` | `UserOrder`      | Ordering options for users returned from the connection                |
| `where`   | `UserWhereInput` | Filtering options for users returned from the connection               |

## Return Type

`UserConnection!` - A connection to a list of User objects with pagination information.

## Usage Example

```graphql
query {
  # Search users by email domain
  users(
    where: {
      emailContains: "@company.com"
    },
    orderBy: { direction: ASC, field: CREATED_AT }
  ) {
    edges {
      node {
        id
        username
        email
        firstName
        lastName
        isAdmin
        tenantID
        company {
          id
          name
        }
        roles {
          id
          name
        }
        groups {
          id
          name
        }
      }
      cursor
    }
    totalCount
  }
}
```

```graphql
query {
  # Get admin users
  users(
    where: {
      isAdmin: true
    },
    first: 20
  ) {
    edges {
      node {
        id
        username
        email
        firstName
        lastName
        createdAt
        roles {
          id
          name
          description
        }
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
  }
}
```

```graphql
query {
  # Find users by name and company
  users(
    where: {
      firstNameContains: "John",
      hasCompanyWith: [
        { nameContains: "Tech" }
      ]
    }
  ) {
    edges {
      node {
        id
        username
        email
        firstName
        lastName
        company {
          id
          name
          organizationID
        }
        roles {
          name
        }
      }
    }
  }
}
```

## Common Filters

* `usernameContains` - Search by username substring
* `username` - Find by exact username
* `emailContains` - Search by email substring
* `email` - Find by exact email address
* `firstNameContains` / `lastNameContains` - Search by name
* `isAdmin` - Filter by admin status
* `tenantID` - Filter by tenant
* `hasCompany` - Filter users who have a company
* `hasCompanyWith` - Filter by company criteria
* `hasRoles` - Filter users who have roles
* `hasRolesWith` - Filter by role criteria

## Notes

* Users are authenticated through an Identity Provider (IDP)
* Each user belongs to a tenant for multi-tenancy support
* Users can be associated with a company within their tenant
* Role-based access control through roles and groups
* Legacy roles field is deprecated in favor of role relations
* Admin users have elevated privileges across the system
* Integration with external authentication systems via idpID field


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pyck.cloud/graphql-api/queries/users.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.