---
title: "List Vault Groups"
method: GET
path: "/api/v1/vault-groups"
tags: ["Vault Groups"]
---

# List Vault Groups

`GET /api/v1/vault-groups`

Get a list of vault groups in the organization.

## Query parameters

- `sort_by` VaultGroupSortableFields[]
- `page` integer — The page number to fetch.
- `size` integer — The number of items per page.
- `skip_count` boolean — Whether to skip counting the total number of items.
- `vault_group_ids` string[] — Vault group IDs to filter on.
- `search` string
- `access_level` 'view' | 'create_edit' | 'all'
- `exclude_vault_group_ids` string[] — Vault group IDs to exclude.
- `states` VaultGroupState[] — Vault group states to filter on.

## Response `200`

Successful Response

- ListVaultGroupsResponse
  - `total` integer, required
  - `page` integer, required
  - `size` integer, required
  - `vault_groups` VaultGroup[], required
    - `id` string, uuid, required — The unique identifier of the object in the Fordefi platform.
    - `created_at` string, date-time, required — The date and time when the object was created.
    - `modified_at` string, date-time, required — The date and time when the object was last modified. Any change to any field of the resource is considered a modification.
    - `name` string, required — The name of the vault group.
    - `created_by` union — Represents a reference to a user in the Fordefi platform
      - PersonRef
        - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
        - `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer.
        - `name` string — The name of the user.
        - `email` string, required — The email of the user.
        - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required
        - `role` 'admin' | 'trader' | 'viewer', required
      - ApiUserRef
        - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
        - `user_type` 'api_user', required — The type of the user.
        - `name` string, required — The name of the user.
        - `state` 'active' | 'deleted', required — The state of the user.
        - `role` 'admin' | 'trader' | 'viewer', required
      - ApiSignerRef
        - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
        - `user_type` 'api_signer', required — The type of the user.
        - `name` string, required — The name of the user.
        - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user.
      - EndUserRef
        - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
        - `user_type` 'end_user', required — The type of the user.
        - `external_id` string, required — External id of the user.
        - `state` 'active' | 'deleted', required — The state of the user.
      - SystemUserRef
        - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
        - `user_type` 'system', required — The type of the user.
        - `name` string, required — The name is Fordefi CARE
    - `vaults_count` BoundCount, required — BoundCount represents a bound count of items.
      - `count` integer, required — The number of items in the bound count.
      - `has_more` boolean, required — Whether there are more items in the bound count.
    - `permissions` VaultGroupPermissions, required
      - `access_permissions` union, required — The access type of the permissions.
        - VaultGroupAccessPermissionsAll
          - `access_type` 'all', required — access type
        - VaultGroupAccessPermissionsPermitted
          - `access_type` 'permitted', required — access type
          - `user_groups` UserGroupRef[], required — The list of permitted user group
            - `id` string, uuid, required — The unique identifier of user group in the Fordefi platform.
            - `name` string, required — The name of the user group.
            - `users_count` integer, required — The number of users in the group.
            - `admins_count` integer, required — The number of admins in the group.
            - `state` 'active' | 'deleted', required — Represents a user group state in the Fordefi platform
          - `users` UserRef[], required — The list of permitted users
            - union — Represents a reference to a user in the Fordefi platform
              - …
      - `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
      - `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
    - `owner` 'system' | 'user', required
    - `modified_by` union — Represents a reference to a user in the Fordefi platform
      - PersonRef
        - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
        - `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer.
        - `name` string — The name of the user.
        - `email` string, required — The email of the user.
        - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required
        - `role` 'admin' | 'trader' | 'viewer', required
      - ApiUserRef
        - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
        - `user_type` 'api_user', required — The type of the user.
        - `name` string, required — The name of the user.
        - `state` 'active' | 'deleted', required — The state of the user.
        - `role` 'admin' | 'trader' | 'viewer', required
      - ApiSignerRef
        - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
        - `user_type` 'api_signer', required — The type of the user.
        - `name` string, required — The name of the user.
        - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user.
      - EndUserRef
        - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
        - `user_type` 'end_user', required — The type of the user.
        - `external_id` string, required — External id of the user.
        - `state` 'active' | 'deleted', required — The state of the user.
      - SystemUserRef
        - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
        - `user_type` 'system', required — The type of the user.
        - `name` string, required — The name is Fordefi CARE
    - `pending_change_request` VaultGroupPendingChangeRequestInfo
      - `id` string, uuid, required — ID of a 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.
      - `created_by` union, required — Represents a reference to a user in the Fordefi platform
        - PersonRef
          - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
          - `user_type` 'person', required — The type of user. Can be a person, or (in programmatic scenarios) an API user or API Signer.
          - `name` string — The name of the user.
          - `email` string, required — The email of the user.
          - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'reset_device_pending_code_generation' | 'reset_device_pending_activation' | 'pending_approval' | 'deleted', required
          - `role` 'admin' | 'trader' | 'viewer', required
        - ApiUserRef
          - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
          - `user_type` 'api_user', required — The type of the user.
          - `name` string, required — The name of the user.
          - `state` 'active' | 'deleted', required — The state of the user.
          - `role` 'admin' | 'trader' | 'viewer', required
        - ApiSignerRef
          - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
          - `user_type` 'api_signer', required — The type of the user.
          - `name` string, required — The name of the user.
          - `state` 'active' | 'onboarding_pending_code_generation' | 'onboarding_pending_activation' | 'deleted', required — The state of the user.
        - EndUserRef
          - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
          - `user_type` 'end_user', required — The type of the user.
          - `external_id` string, required — External id of the user.
          - `state` 'active' | 'deleted', required — The state of the user.
        - SystemUserRef
          - `id` string, uuid, required — The unique identifier of the user in the Fordefi platform.
          - `user_type` 'system', required — The type of the user.
          - `name` string, required — The name is Fordefi CARE
      - `created_at` string, date-time, required — The date and time when change request was initiated.
    - `state` 'pending_approval' | 'active' | 'deleted', required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized User
- `403` — Forbidden User
- `408` — Request Timeout
- `422` — Validation Error
- `429` — Rate Limit Exceeded
- `500` — Unexpected Error

---

[API](https://skmtc.net/fordefi/apis/fordefi-api.md) · [All operations](https://skmtc.net/fordefi/apis/fordefi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fordefi/fordefi-api/versions/8014fd69ea17/schema)