# List User Groups

Get a list of user groups

Endpoint: GET /api/v1/user-groups
Version: 0.2.0
Security: bearerAuth

## Query parameters:

  - `page` (integer)
    The page number to fetch.

  - `size` (integer)
    The number of items per page.

  - `states` (array)
    Enum: "active", "deleted"

  - `user_group_ids` (array)

  - `user_ids` (array)

  - `modified_by` (array)

  - `name` (string)

  - `search` (string)

  - `exclude_user_group_ids` (array)
    The group IDs to exclude.

  - `sort_by` (array)
    Enum: "created_at_asc", "created_at_desc", "modified_at_asc", "modified_at_desc", "name_asc", "name_desc", "users_count_asc", "users_count_desc"

## Response 200 fields (application/json):

  - `total` (integer, required)

  - `page` (integer, required)

  - `size` (integer, required)

  - `user_groups` (array, required)

  - `user_groups.id` (string, required)
    The unique identifier of the object in the Fordefi platform.

  - `user_groups.created_at` (string, required)
    The date and time when the object was created.

  - `user_groups.modified_at` (string, required)
    The date and time when the object was last modified. Any change to any field of the resource is considered a modification.

  - `user_groups.name` (string, required)
    The name of the user group.

  - `user_groups.users_count` (integer, required)
    The number of users in the group.

  - `user_groups.admins_count` (integer, required)
    The number of admins in the group.

  - `user_groups.state` (string, required)
    The state of the user group.
    Enum: "active", "deleted"

  - `user_groups.modified_by` (any, required)

  - `user_groups.proposed_change` (object)
    The change proposal for the group.

  - `user_groups.proposed_change.id` (string, required)
    The ID of the change proposal.

  - `user_groups.proposed_change.created_at` (string, required)
    The time the change proposal was created.

  - `user_groups.proposed_change.created_by` (any, required)

  - `user_groups.proposed_change.new_name` (string)
    The new name of the group if it is changed.

  - `user_groups.proposed_change.added_users` (array)
    The users added to the group.

  - `user_groups.proposed_change.removed_users` (array)
    The users removed from the group.

## Response 400 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

  - `system_error_code` (string)
    An additional system error code in Fordefi.

## Response 401 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

## Response 403 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

## Response 408 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

## Response 422 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (array, required)

  - `detail.loc` (array, required)

  - `detail.msg` (string, required)

  - `detail.type` (string, required)

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.

## Response 500 fields (application/json):

  - `title` (string, required)
    Human-readable error message.

  - `detail` (string, required)
    Detailed error message.

  - `full_detail` (string)
    Full error message with additional details, if available.

  - `request_id` (string)
    Request ID - for debugging purposes.