List business accounts
OAuth scope: organization.read
Retrieves a list of all business accounts.
You can use this endpoint when you need to display account details of all business accounts.
Restricted Fields
Full details of a business account are restricted to users with specific permissions (more on permissions). Owners and admins can access all fields. Other users, such as managers, will only see a limited set of fields unless granted the appropriate permissions.
Fields Available to All Users:
id
name
status
main
organization_id
Fields Available to Users with Balance Authorization Read:
currency
balance
balance_cents
authorized_balance
authorized_balance_cents
Depending on the userβs permissions, the corresponding fields will be included in the response.
Authorizations
Bearer authorization header: Bearer <token>
, where <token>
is the access token received from the authorization server at the end of the OAuth 2.0 flow.
Headers
Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.
Query Parameters
Page number for pagination. Must be greater than 0.
x >= 1
Number of business accounts per page. Must be between 1 and 100.
1 <= x <= 100
Response
The response is of type object
.