> ## Documentation Index > Fetch the complete documentation index at: https://cobo.com/developers/llms.txt > Use this file to discover all available pages before exploring further. # List all key share holder groups > This operation retrieves all key share holder groups under a specified vault. You can filter the result by group type. Try [Cobo WaaS Skill](/v2/guides/overview/cobo-waas-skill) in your AI coding assistant (Claude Code, Cursor, etc.). Describe your needs in natural language to auto-generate production-ready SDK code and debug faster 🚀 ```python Python theme={null} import cobo_waas2 from cobo_waas2.models.key_share_holder_group_type import KeyShareHolderGroupType from cobo_waas2.models.list_key_share_holder_groups200_response import ( ListKeyShareHolderGroups200Response, ) from cobo_waas2.rest import ApiException from pprint import pprint # See configuration.py for a list of all supported configurations. configuration = cobo_waas2.Configuration( # Replace `` with your private key api_private_key="", # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2. host="https://api.dev.cobo.com/v2", ) # Enter a context with an instance of the API client with cobo_waas2.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = cobo_waas2.WalletsMPCWalletsApi(api_client) vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479" key_share_holder_group_type = cobo_waas2.KeyShareHolderGroupType() limit = 10 before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1" after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk" try: # List all key share holder groups api_response = api_instance.list_key_share_holder_groups( vault_id, key_share_holder_group_type=key_share_holder_group_type, limit=limit, before=before, after=after, ) print("The response of WalletsMPCWalletsApi->list_key_share_holder_groups:\n") pprint(api_response) except Exception as e: print( "Exception when calling WalletsMPCWalletsApi->list_key_share_holder_groups: %s\n" % e ) ``` ```java Java theme={null} // Import classes: import com.cobo.waas2.ApiClient; import com.cobo.waas2.ApiException; import com.cobo.waas2.Configuration; import com.cobo.waas2.Env; import com.cobo.waas2.api.WalletsMpcWalletsApi; import com.cobo.waas2.model.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Select the development environment. To use the production environment, replace `Env.DEV` with // `Env.PROD defaultClient.setEnv(Env.DEV); // Replace `` with your private key defaultClient.setPrivKey(""); WalletsMpcWalletsApi apiInstance = new WalletsMpcWalletsApi(); UUID vaultId = UUID.fromString("f47ac10b-58cc-4372-a567-0e02b2c3d479"); KeyShareHolderGroupType keyShareHolderGroupType = KeyShareHolderGroupType.fromValue("MainGroup"); Integer limit = 10; String before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"; String after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"; try { ListKeyShareHolderGroups200Response result = apiInstance.listKeyShareHolderGroups( vaultId, keyShareHolderGroupType, limit, before, after); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling WalletsMpcWalletsApi#listKeyShareHolderGroups"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ```go Go theme={null} package main import ( "context" "fmt" coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2" "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto" "os" ) func main() { vaultId := "f47ac10b-58cc-4372-a567-0e02b2c3d479" keyShareHolderGroupType := coboWaas2.KeyShareHolderGroupType("MainGroup") limit := int32(10) before := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1" after := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk" configuration := coboWaas2.NewConfiguration() // Initialize the API client apiClient := coboWaas2.NewAPIClient(configuration) ctx := context.Background() // Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv) // Replace `` with your private key ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{ Secret: "", }) resp, r, err := apiClient.WalletsMPCWalletsAPI.ListKeyShareHolderGroups(ctx, vaultId). KeyShareHolderGroupType(keyShareHolderGroupType). Limit(limit). Before(before). After(after). Execute() if err != nil { fmt.Fprintf( os.Stderr, "Error when calling `WalletsMPCWalletsAPI.ListKeyShareHolderGroups``: %v\n", err, ) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `ListKeyShareHolderGroups`: ListKeyShareHolderGroups200Response fmt.Fprintf( os.Stdout, "Response from `WalletsMPCWalletsAPI.ListKeyShareHolderGroups`: %v\n", resp, ) } ``` ```javascript JavaScript theme={null} const CoboWaas2 = require("@cobo/cobo-waas2"); // Initialize the API client const apiClient = CoboWaas2.ApiClient.instance; // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD` apiClient.setEnv(CoboWaas2.Env.DEV); // Replace `` with your private key apiClient.setPrivateKey(""); // Call the API const apiInstance = new CoboWaas2.WalletsMPCWalletsApi(); const vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"; const opts = { key_share_holder_group_type: new CoboWaas2.KeyShareHolderGroupType(), limit: 10, before: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1", after: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk", }; apiInstance.listKeyShareHolderGroups(vault_id, opts).then( (data) => { console.log("API called successfully. Returned data: " + data); }, (error) => { console.error(error); }, ); ``` ## OpenAPI ````yaml get /wallets/mpc/vaults/{vault_id}/key_share_holder_groups openapi: 3.0.3 info: title: Cobo Wallet as a Service 2.0 description: > The Cobo Wallet-as-a-Service (WaaS) 2.0 API is the latest version of Cobo's WaaS API offering. It enables you to access Cobo's full suite of crypto wallet technologies with powerful and flexible access controls. By encapsulating complex security protocols and streamlining blockchain interactions, this API allows you to concentrate on your core business activities without worrying about the safety of your assets. The WaaS 2.0 API presents the following key features: - A unified API for Cobo's [all four wallet types](https://manuals.cobo.com/en/portal/introduction#an-all-in-one-wallet-platform) - Support for 80+ chains and 3000+ tokens - A comprehensive selection of webhook events - Flexible usage models for MPC Wallets, including [Organization-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/introduction) and [User-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/ucw/introduction) - Programmatic control of smart contract wallets such as Safe{Wallet} with fine-grained access controls - Seamlessly transfer funds across multiple exchanges, including Binance, OKX, Bybit, Deribit, and more For more information about the WaaS 2.0 API, see [Introduction to WaaS 2.0](https://www.cobo.com/developers/v2/guides/overview/introduction). termsOfService: https://cobo.com/waas/tos/ license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html contact: name: Cobo WaaS url: https://www.cobo.com/waas email: help@cobo.com version: 1.0.0 servers: - url: https://api.dev.cobo.com/v2 description: Development environment - url: https://api.cobo.com/v2 description: Production environment security: - CoboAuth: [] tags: - name: Organizations description: Operations related to Organizations. - name: Wallets description: Operations related to all wallets. - name: Wallets - MPC Wallets description: Operations related to mpc wallet. - name: Wallets - Exchange Wallet description: Operations related to exchange wallet. - name: Wallets - Smart Contract Wallets description: Operations related to smart contract wallet. - name: Transactions description: Operations related to all transactions. - name: Developers - Webhooks description: Operations related to webhooks. - name: Stakings description: Operations related to staking. - name: OAuth description: Operations related to OAuth. - name: Developers description: Operations related to developers. - name: AddressBooks description: Operations related to address books. - name: TravelRule description: Operations related to travel rule. - name: GraphQL description: Operations related to executing GraphQL queries and mutations. - name: PrimeBroker description: Operations related to prime broker. - name: AppWorkflows description: Operations related to app workflow. - name: FeeStation description: Operations related to fee station. - name: Payment description: Operations related to payment. - name: Batch Payouts description: Operations related to batch payouts. - name: Tokenization description: Operations related to tokenization. - name: AutoSweep description: Operations related to auto sweep. - name: Compliance description: Operations related to compliance. paths: /wallets/mpc/vaults/{vault_id}/key_share_holder_groups: get: tags: - Wallets - MPC Wallets summary: List all key share holder groups description: > This operation retrieves all key share holder groups under a specified vault. You can filter the result by group type. operationId: list_key_share_holder_groups parameters: - $ref: '#/components/parameters/vaultIdParam' - $ref: '#/components/parameters/optionalKeyShareHolderGroupTypeParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/beforeParam' - $ref: '#/components/parameters/afterParam' responses: '200': $ref: '#/components/responses/getKeyShareHolderGroupsResponse' 4XX: $ref: '#/components/responses/badRequestError' 5XX: $ref: '#/components/responses/internalServerError' security: - CoboAuth: [] - OAuth2: - mpc_key_group.read components: parameters: vaultIdParam: name: vault_id in: path required: true description: >- The vault ID, which you can retrieve by calling [List all vaults](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/list-all-vaults). schema: type: string format: uuid example: f47ac10b-58cc-4372-a567-0e02b2c3d479 optionalKeyShareHolderGroupTypeParam: name: key_share_holder_group_type in: query description: > The key share holder group type. Possible values include: - `MainGroup`: The [Main Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups#main-group). - `SigningGroup`: The [Signing Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups#signing-group). - `RecoveryGroup`: The [Recovery Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups#recovery-group). **Note**: If this parameter is left empty, all key share holder group types will be retrieved. required: false schema: $ref: '#/components/schemas/KeyShareHolderGroupType' limitParam: name: limit in: query description: >- The maximum number of objects to return. For most operations, the value range is [1, 50]. required: false schema: type: integer format: int32 default: 10 example: 10 beforeParam: name: before in: query description: > A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. required: false schema: type: string example: RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1 afterParam: name: after in: query description: > A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. required: false schema: type: string example: RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk responses: getKeyShareHolderGroupsResponse: description: Successfully listed key share holder groups. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/KeyShareHolderGroup' pagination: $ref: '#/components/schemas/Pagination' badRequestError: description: >- Bad request. Your request contains malformed syntax or invalid parameters. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' internalServerError: description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' schemas: KeyShareHolderGroupType: type: string enum: - MainGroup - SigningGroup - RecoveryGroup example: MainGroup description: > The type of key share holder group. Possible values include: - `MainGroup`: A [Main Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups). - `SigningGroup`: A [Signing Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups). - `RecoveryGroup`: A [Recovery Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups). **Note:** For `MainGroup` and `SigningGroup`, a Cobo key share holder will be added automatically. KeyShareHolderGroup: type: object description: The data for key share holder group information. properties: key_share_holder_group_id: type: string example: b33130a9-6e18-44a9-9e48-8b3b41921f0e description: The key share holder group ID. type: $ref: '#/components/schemas/KeyShareHolderGroupType' tss_key_share_groups: type: array items: $ref: '#/components/schemas/TSSGroups' key_share_holders: type: array items: $ref: '#/components/schemas/KeyShareHolder' participants: type: integer description: The number of key share holders in this key share holder group. example: 3 threshold: type: integer description: >- The number of key share holders required to approve each operation in this key share holder group. example: 2 status: $ref: '#/components/schemas/KeyShareHolderGroupStatus' created_timestamp: type: integer format: int64 description: >- The key share holder group's creation time in Unix timestamp format, measured in milliseconds. example: 1718619403933 Pagination: type: object description: The pagination information of the returned data. required: - before - after - total_count properties: before: type: string example: RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1 description: > An object ID used to retrieve records before the specified object, indicating earlier or smaller records relative to the current dataset. You can use it to paginate backwards. If empty, it means you have reached the start of the data. Most API endpoints sort by object ID, but some use other fields depending on the endpoint. after: type: string example: RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk description: > An object ID used to retrieve records after the specified object, indicating newer or larger records relative to the current dataset. You can use it to paginate forwards. If empty, it means you have reached the end of the data. Most API endpoints sort by object ID, but some use other fields depending on the endpoint. total_count: type: integer example: 10000 description: >- The total number of records that match the query criteria, unaffected by the pagination parameters (`before` , `after`, and `limit`). ErrorResponse: type: object description: The response of a failed request. required: - error_code - error_message - error_id properties: error_code: type: integer description: >- The error code. Refer to [Error codes and status codes](https://www.cobo.com/developers/v2/api-references/error-codes) for more details. error_message: type: string description: The error description. error_id: type: string description: >- The error log ID. You can provide the error ID when submitting a ticket to help Cobo to locate the issue. example: 0b6ddf19083c4bd1a9ca01bec44b24dd TSSGroups: type: object description: The data for the TSS key share group. properties: tss_key_share_group_id: type: string description: The TSS key share group ID. example: mMedDioOKhTlhGyQRzMv curve: $ref: '#/components/schemas/CurveType' root_pubkey: type: string description: >- The vault's [root extended public key](https://www.cobo.com/developers/v2/guides/mpc-wallets/get-started-ocw#root-extended-public-keys). example: >- xpub661MyMwAqRbcG4vPNi58VQJrXW8D9VzmauuRq2rTY3oUVnKGuLTxQxvvoEXgLvZ7N9GQXQkWVgKn1rzEUUEm4NdvrBKUqjpNJEnn2UL4rYq KeyShareHolder: type: object description: The data for MPC Wallets' key share holder information. properties: name: type: string description: The key share holder name. example: Key share holder name type: $ref: '#/components/schemas/KeyShareHolderType' tss_node_id: type: string description: The key share holder's TSS Node ID. example: coboAbCdEfGhIjKlMnOpQrStUvWxYz1234567890abcdefghi online: type: boolean description: | Whether the key share holder's TSS Node is online. - `true`: The TSS Node is online. - `false`: The TSS Node is offline. signer: type: boolean example: true description: > Whether the key share holder has been selected as the designated transaction signer. For example, in a 2-3 [Threshold Signature Scheme (TSS)](https://manuals.cobo.com/en/portal/mpc-wallets/introduction#threshold-signature-scheme-tss), Cobo will serve as one signer, and you can choose one of the other two key share holders to act as the second transaction signer. - `true`: The key share holder is a designated transaction signer. - `false`: The key share holder is not a designated transaction signer. status: $ref: '#/components/schemas/KeyShareHolderStatus' account_id: type: string description: The key share holder's Cobo Portal account ID. example: auth0|cobo|839305394802991371 KeyShareHolderGroupStatus: type: string enum: - New - Valid - Unavailable example: Valid description: > The status of the key share holder group. Possible values include: - `New`: The key share holder group has been newly created. The status will become `Valid` after you call [Create TSS request](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallets/create-tss-request) and specifying this key share holder group as the target key share holder group. - `Valid`: The key share holder group is valid. - `Unavailable`: The key share holder group is currently unavailable. This status appears when a key share holder uses [mobile co-signer](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/back-up-key-share-groups#mobile-co-signer) to change node. For example, when a key share holder changes to a new phone or loses their phone, and is in the process of setting up [Cobo Guard](https://manuals.cobo.com/en/guard/introduction) on their new phone. CurveType: type: string enum: - SECP256K1 - ED25519 example: SECP256K1 description: > The elliptic curve type of the [root extended public key](https://www.cobo.com/developers/v2/guides/mpc-wallets/get-started-ocw#root-extended-public-keys). Possible values include: - `SECP256K1`: The secp256k1 elliptic curve. - `ED25519`: The Ed25519 elliptic curve. KeyShareHolderType: type: string enum: - Cobo - Mobile - API example: API description: > The key share holder's TSS Node type. Possible values include: - `Cobo`: The TSS Node is generated and held by Cobo. - `Mobile`: The TSS Node is generated and held by a [mobile co-signer](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups#create-a-main-group) using [Cobo Guard](https://manuals.cobo.com/en/guard/introduction). - `API`: The TSS Node is generated and held by a [server co-signer](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups#create-a-main-group) using the [TSS Node software package](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/tss-node-deployment). KeyShareHolderStatus: type: string enum: - Valid - NotConfigured - NotActivated - Changed example: Valid description: > The status of key share holder's TSS Node. Possible values include: - `Valid`: The TSS Node is configured and activated. - `NotConfigured`: The TSS Node has not been configured. This status is only applicable to [mobile co-signer](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/back-up-key-share-groups#mobile-co-signer) using the [Cobo Guard](https://manuals.cobo.com/en/guard/introduction). - `NotActivated`: The TSS Node has not been activated. This status is only applicable to [mobile co-signer](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/back-up-key-share-groups#mobile-co-signer) using the [Cobo Guard](https://manuals.cobo.com/en/guard/introduction). - `Changed`: The TSS Node has been changed. This happens when the key share holder sets up their [Cobo Guard](https://manuals.cobo.com/en/guard/introduction) on a new phone. This `Changed` status serves as a reminder for you to call [Create TSS request](https://www.cobo.com/developers/v2/api-references/wallets--mpc-wallet/create-a-tss-request-to-generate-key-secrets-for-a-tss-group) with the `KeyGenFromKeyGroup` and `Recovery` action `type` to finalize the setup of the key share holder's new phone. Once all set, the old TSS Node with the `Changed` status will be deleted. securitySchemes: CoboAuth: type: apiKey in: header name: BIZ-API-KEY description: > The API key. For more details, refer to [API key](https://www.cobo.com/developers/v2/guides/overview/cobo-auth#api-key). In the API playground, enter your [API secret](https://www.cobo.com/developers/v2/guides/overview/cobo-auth#api-secret), and your API key will be accordingly calculated. OAuth2: type: oauth2 description: >- The [Org Access Token](https://www.cobo.com/developers/v2/apps/org-access-tokens). Use this authorization method only if you are developing Cobo Portal Apps for installation and use across different organizations. flows: authorizationCode: authorizationUrl: https://auth.cobo.com/authorize tokenUrl: https://auth.cobo.com/oauth/token scopes: address_book.read: Read address book api_key.read: Read API key information callback.read: Read callback message callback.resend: Resend callback message wallet.create: Create wallet wallet.read: Read wallet information wallet.update: Update wallet information wallet.delete: Delete wallet information wallet.create_address: Create wallet address wallet.manage_utxo: Manage UTXO mpc_project.create: Create MPC project mpc_project.read: Read MPC project information mpc_project.update: Update MPC project information mpc_vault.create: Create MPC Vault mpc_vault.read: Read MPC Vault information mpc_vault.update: Update MPC Vault information mpc_key_group.create: Create MPC key group mpc_key_group.read: Read MPC key group information mpc_key_group.update: Update MPC key group information mpc_key_group.delete: Delete MPC key group information transaction.read: Read transaction information transaction.withdraw: Make withdrawals transaction.estimate_fee: Estimate transaction fee transaction.contract_call: Initiate contract calls transaction.message_sign: Initiate message signings transaction.stake: Stake assets transaction.unstake: Unstake assets transaction.unstake_withdraw: Withdraw unstaked assets transaction.manage: Manage ongoing transactions transaction.update: Update transaction notes travel_rule.read: Read travel rule information travel_rule.edit: Edit travel rule information webhook.read: Read webhook URLs/events webhook.edit: Edit webhook URLs webhook.resend: Resend webhook events payment_orders_payin.create: Create pay-in order payment_orders_payin.read: Read pay-in order information payment_orders_payin.update: Update pay-in order payment_orders_refund.create: Create payment refund order payment_orders_refund.read: Read payment refund order information payment_settlement.create: Create payment settlement request payment_settlement.read: Read payment settlement request information payment_merchant.create: Create payment merchant payment_merchant.read: Read payment merchant information payment_merchant.update: Update payment merchant payment_forced_sweep.create: Create payment force sweep request payment_forced_sweep.read: Read payment force sweep request information compliance_funds.refund: Refund compliance funds request compliance_funds.isolate: Isolate compliance funds request compliance_funds.unfreeze: Unfreeze compliance funds request compliance_funds.read: Read compliance funds request information compliance_kyt_review.update: Update KYT review status compliance_kyt_decisions.update: Update KYT decision status compliance_kyt_status.read: Read KYT screening status compliance_kya_screenings.create: Create KYA address screening requests compliance_kya_screenings.read: Read KYA address screening results ````