Skip to main content
GET
List Group Types
Works on any account you own. Create Virtual Account Group covers who can open a group and what the account needs first. A virtual account group tracks an account’s onboarding requirements, approval, and activation for a group type. Before you can create virtual accounts under the group, its onboarding_status must be approved and its status must be enabled. You can onboard the same account for multiple group types, with one group per type. Each group is onboarded and enabled separately, and each virtual account belongs to one group. This endpoint lists the group types available to open. The list is the same for every customer in an environment. The customer_id in the path scopes the call to your customer; it does not filter the catalogue. Take type from an entry here and pass it as the type body field of Create Virtual Account Group. The response is a plain {"items": [...]} object. It is not paginated, carries no page, size, total or pages, and takes no query parameters. Requires an API key with read access on the virtual_accounts scope.

Path Parameters

string
required
The customer’s external ID (starts with cus_)

Response

array
Group type objects. The order follows Hop’s configuration and is stable within an environment.

Errors

Request Example

Response Example