List Wallets

Overview

This endpoint returns a list of all wallets accessible to the authenticated Hover organization. Beyond your organization's primary wallet, the response also includes wallets that have been shared with your organization. This allows you to manage and utilize funds across various interconnected Hover organizations.

Wallet Prioritization

Wallets are returned in a specific order of preference:

  1. Preferred Shared Wallets: Wallets explicitly designated as preferred shares.
  2. Shared Wallets: Wallets shared with your organization.
  3. Your Own Wallet: The wallet directly associated with your authenticated Hover organization.

Note: The wallet directly associated with your organization will always be included in the response body, regardless of shared wallets.

For more information about wallet shares, please consult this guide.

Sample Response

{
    "pagination": {
        "current_page": 1,
        "total_pages": 1,
        "total": 1
    },
    "results": [
        {
            "id": 463517,
            "preferred": false,
            "shared": false,
            "allowed_good_types": [
                "Job",
                "BlueprintJob",
                "Deposit",
                "Plan",
                "OrgJobAccess",
                "Org",
                "Inspection::DamageInitial",
                "Inspection::DamageRepeat"
            ],
            "org": {
                "name": "Jamie's Remodeling",
                "customer_display_name": "Jamie's Remodeling",
                "invoiced": false
            },
            "external_identifier_patterns": [],
            "external_identifier_strict_validation": false
        }
    ]
}
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!