List users

​

List the end users registered under your account, paginated. Use subaccountId to list one subaccount's users instead, or includeSubaccounts=true to span your account and its subaccounts. Never spans another customer's account.

Query Parameters
  • subaccountId
    Type: string Format: uuid

    Scope this read to one of your subaccounts instead of the authenticated account. Must be a direct child of the authenticated account.

  • includeSubaccounts
    Type: string enum

    Set to true to include your subaccounts' records alongside your own. true cannot be combined with subaccountId; false can, and means the same as omitting it.

    values
    • true
    • false
  • limit
    Type: integer
    min:  
    1
    max:  
    100

    Integer numbers.

  • offset
    Type: integer
    min:  
    0
    max:  
    9007199254740991

    Integer numbers.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/api/v1/users
curl https://api.bettermoney.com/api/v1/users

{
  "users": [
    {
      "id": "string",
      "label": "string",
      "accountId": "123e4567-e89b-12d3-a456-426614174000",
      "wallets": [
        {
          "address": "string",
          "chain": "string",
          "status": "PENDING"
        }
      ]
    }
  ],
  "total": 1
}

Default Response