Use this endpoint to retrieve information about your sub accounts. You can filter by email, creation date, type, name, or status. The results are paginated and ordered by creation date
Use API key permission Accounts Read to perform this request
This endpoint is backward compatible with Accounts created using the /accounts endpoint
The email addresses of the accounts that will be filtered. If not specified, all account emails will be returned.
The statuses of the accounts that will be filtered. If not specified, all account status will be returned.
The public profile or business name of the accounts that will be filtered. If not specified, all account business name will be returned. This is the business name specified during account creation
The type of accounts that will be filtered. If not specified, all account types will be returned.
Start time of accounts by created date. If not specified will list all dates.
End time of accounts by created date. If not specified will list all dates.
Start time of accounts by updated date. If not specified will list all dates.
End time of accounts by updated date. If not specified will list all dates.
A limit on the number of transactions to be returned for each request.
ID of the immediately following item.
ID of the immediately previous item. Use this with links on the response for pagination.
{
"data": [
{
"id": "5cafeb170a2b18519b1b8761",
"created": "2021-01-01T10:00:00Z",
"updated": "2021-01-01T10:00:00Z",
"type": "OWNED",
"email": "angie@pinkpanther.com",
"public_profile": {
"business_name": "Angie's lemonade stand"
},
"status": "LIVE"
},
{
"id": "3cafeb170a2b18519b1b8762",
"created": "2023-03-22T09:15:00Z",
"updated": "2023-03-22T09:30:00Z",
"type": "MANAGED",
"email": "carol@cooldrinks.com",
"public_profile": {
"business_name": "Carol's Cool Drinks"
},
"status": "LIVE"
}
],
"has_more": true,
"links": [
{
"href": "/v2/accounts?after_id=623ace8270bbddf93816b3g1",
"rel": "next",
"method": "GET"
}
]
}ID of your Account, use this in the for-user-id header to create transactions on behalf of your Account
Timestamp of when the object was created
Timestamp of when the object was updated
The type of account created
A valid email address associated with the object
Public name of the account.
Additional description visible publicly.
The country (based on ISO 3166-1 Alpha-2) of incorporation for a business, or the country of residence for an individual.
Status of the Account you are creating.
Indicates whether there are more items to be queried with after_id of the last item from the current result.
Use the links to follow to the next result.
The links to the next page based on HATEOAS if there is next result.
The HATEOAS format are:
href: URI of target, this will be to the next link.
rel: The relationship between source and target. The value will be next.
method: The HTTP method, the alue will be GET.