> 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/types/group.md).

# Group

Group Type

Represents a group of users in the system. Groups provide a way to organize users and assign roles collectively for access control and permissions management.

## Fields

| Field         | Type      | Description                                |
| ------------- | --------- | ------------------------------------------ |
| `id`          | `ID!`     | Unique identifier of the group             |
| `createdAt`   | `Time!`   | Creation timestamp                         |
| `createdBy`   | `UUID!`   | User identifier who created the group      |
| `updatedAt`   | `Time`    | Last update timestamp                      |
| `updatedBy`   | `UUID`    | User identifier who last updated the group |
| `deletedAt`   | `Time`    | Deletion timestamp                         |
| `deletedBy`   | `UUID`    | User identifier who deleted the group      |
| `tenantID`    | `UUID!`   | Tenant identifier                          |
| `name`        | `String!` | Name of the group                          |
| `description` | `String`  | Description of the group                   |

## Connection Fields

The `users` and `roles` fields return Connection objects that support pagination, filtering, and ordering.

### users Connection

```graphql
users(
  after: Cursor
  first: Int
  before: Cursor
  last: Int
  orderBy: UserOrder
  where: UserWhereInput
): UserConnection!
```

### roles Connection

```graphql
roles(
  after: Cursor
  first: Int
  before: Cursor
  last: Int
  orderBy: RoleOrder
  where: RoleWhereInput
): RoleConnection!
```

| Argument  | Type          | Description                                          |
| --------- | ------------- | ---------------------------------------------------- |
| `after`   | `Cursor`      | Returns elements after this cursor                   |
| `first`   | `Int`         | Returns the first n elements                         |
| `before`  | `Cursor`      | Returns elements before this cursor                  |
| `last`    | `Int`         | Returns the last n elements                          |
| `orderBy` | `*Order`      | Ordering options (UserOrder or RoleOrder)            |
| `where`   | `*WhereInput` | Filtering options (UserWhereInput or RoleWhereInput) |

## Interfaces

* `Node`

## Usage Example

```graphql
query {
  groups(first: 10) {
    edges {
      node {
        id
        name
        description
        users(first: 50) {
          edges {
            node {
              id
              username
              email
              firstName
              lastName
            }
          }
          pageInfo {
            hasNextPage
            endCursor
          }
          totalCount
        }
        roles(first: 20) {
          edges {
            node {
              id
              name
              description
            }
          }
          totalCount
        }
        createdAt
        updatedAt
      }
    }
  }
}
```

### Query with Filtering on Users

```graphql
query {
  groups(first: 10) {
    edges {
      node {
        id
        name
        users(
          first: 20
          orderBy: { direction: ASC, field: USERNAME }
          where: { isAdmin: false }
        ) {
          edges {
            node {
              id
              username
              email
            }
          }
          totalCount
        }
      }
    }
  }
}
```

## Relations

* **Group** `M:N` **User**: A group can contain multiple users, and users can belong to multiple groups
* **Group** `M:N` **Role**: A group can have multiple roles, and roles can be assigned to multiple groups

## Purpose

Groups provide a convenient way to manage permissions by organizing users and assigning roles collectively. Instead of assigning roles to individual users, administrators can assign roles to groups and then add users to those groups. This simplifies access control management in multi-user environments.


---

# 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/types/group.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.