Skip to main content
GET
List Virtual Account Groups
Works on any account you own. Create Virtual Account Group covers who can open a group and what the account needs before onboarding can progress: an identity profile, plus an associated person marked as a signer on a business account. Returns the groups opened for one account, newest first by creation time. There are no sort or filter parameters. An account can hold several groups. List items are the group summary, the same shape Create Virtual Account Group returns. They carry no requirements and no agreements summary: read Get Virtual Account Group for the outstanding onboarding actions on a group. Requires an API key with read access on the virtual_accounts scope.

Path Parameters

string
required
The account’s external ID (starts with acct_). It must belong to your customer: your own account, one of your end-customer accounts, or your fee-collection account.

Query Parameters

integer
default:"1"
Page number (minimum 1)
integer
default:"10"
Items per page (1-100)

Response

array
Virtual account group objects, newest first
integer
Current page number
integer
Items per page
integer
Total number of items
integer
Total number of pages

Errors

Request Example

Response Example