# List Vault Groups

Get a list of vault groups in the organization.

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

## Query parameters:

  - `sort_by` (array)
    Enum: "created_at_asc", "created_at_desc", "name_asc", "name_desc", "vault_count_asc", "vault_count_desc"

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

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

  - `vault_group_ids` (array)
    Vault group IDs to filter on.

  - `search` (string)

  - `access_level` (string)
    Enum: "view", "create_edit", "all"

  - `exclude_vault_group_ids` (array)
    Vault group IDs to exclude.

## Response 200 fields (application/json):

  - `total` (integer, required)

  - `page` (integer, required)

  - `size` (integer, required)

  - `vault_groups` (array, required)

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

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

  - `vault_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.

  - `vault_groups.name` (string, required)
    The name of the vault group.

  - `vault_groups.created_by` (any)

  - `vault_groups.vault_count` (integer, required)
    The number of vaults in the group.

  - `vault_groups.permissions` (object, required)
    The permissions of the vault group

  - `vault_groups.permissions.access_permissions` (any, required)

  - `vault_groups.permissions.can_non_admins_create_or_edit_vaults` (boolean, required)
    True to give create or edit permissions to the user groups. False to allow only admins

  - `vault_groups.permissions.can_current_user_create_or_edit_vaults` (boolean, required)
    Can the current user create or edit vaults in the group's based on the group permissions

  - `vault_groups.owner` (string, required)
    The owner type of the vault group.
    Enum: "system", "user"

  - `vault_groups.modified_by` (any)

  - `vault_groups.pending_change_request` (object)
    Info on pending change request. None if there is no pending change request.

  - `vault_groups.pending_change_request.id` (string, required)
    ID of a pending change request.

  - `vault_groups.pending_change_request.new_name` (string, required)
    New proposed name of the pending change request. None if there is no pending change request or no new name is proposed.

  - `vault_groups.pending_change_request.created_at` (string, required)
    The date and time when change request was initiated.

  - `vault_groups.state` (string, required)
    The state of the vault group.
    Enum: "pending_approval", "active"

## 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.