Skip to main content
GET
List Agreements
This endpoint works on any account you own. Create Virtual Account Group covers who can open a group and what the account needs first. Opening a group with Create Virtual Account Group starts an onboarding that asks the account for two kinds of input: evidence, uploaded with Upload Document, and agreements, the terms the account must accept before the group can be enabled. This endpoint returns the agreements currently attached to the group, newest first. status reflects the provider’s record. Read the terms behind an agreement with Get Agreement Content, and accept or reject it with Submit Agreement Actions. The outstanding requirements and the group’s onboarding status come from Get Virtual Account Group; once the group is enabled you can create virtual accounts under it. Requires an API key with read access on the virtual_accounts scope.

Path Parameters

string
required
The account’s external ID (starts with acct_)
string
required
The virtual account group’s external ID (starts with vag_). It must belong to the account in the path.

Query Parameters

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

Response

array
Agreement objects attached to this group, newest first. There are no sort or filter parameters
integer
Current page number
integer
Items per page
integer
Total number of items
integer
Total number of pages

Errors

Request Example

Response Example