Sign in
Accounts

List accounts.

Changed on
get/v1/accounts

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

limitinteger nullable

Total amount of results to return.

offsetinteger nullable

Offset where to start returning results.

idsstring[] nullable

Account IDs to include.

order_direction'Asc' | 'Desc'

Direction of result ordering for list endpoints.

Direction of the ordering by creation date.

Response

Success

created_atstring date-time required

Date of creation in database.

display_namestring nullable

Optional human-readable name for the account.

idstring uuid required

Stable internal account ID.

permissionsPermission[] nullable

Permissions stored for this account.

updated_atstring date-time nullable

Date of update in database.

Example response

[
  {
    "display_name": "Numeraire",
    "identity": {
      "subject": "auth0|numeraire"
    },
    "wallets": [
      {
        "asset": {
          "asset_ref": "native",
          "code": "BTC",
          "decimals": 11,
          "display_ticker": "BTC",
          "name": "Bitcoin"
        },
        "balance": {
          "available_msat": 989999000,
          "fees_paid_msat": 1000,
          "received_msat": 1000000000,
          "reserved_msat": 2000,
          "sent_msat": 10000000
        },
        "contacts": [
          {
            "ln_address": "dario_nakamoto@numeraire.tech"
          }
        ],
        "invoices": [
          {
            "ln_invoice": {
              "bolt11": "lnbcrt1m1png24kasp5...",
              "expiry": 3600,
              "min_final_cltv_expiry_delta": 10,
              "payee_pubkey": "02086a3f5b67ac4c43...",
              "payment_hash": "b587c7f76339e3fb87ad2b...",
              "payment_secret": "019a32e03bb375a42bc..."
            }
          }
        ],
        "ln_address": {
          "nostr_pubkey": "d9c2ec59a98c..."
        },
        "payments": [
          {
            "error": "failed to pay error message",
            "internal": {
              "btc_address": "bc1q...",
              "ln_address": "hello@numeraire.tech",
              "payment_hash": "b587c7f76339e3fb87ad2b..."
            },
            "lightning": {
              "ln_address": "hello@numeraire.tech",
              "payment_hash": "b587c7f76339e3fb87ad2b..."
            }
          }
        ]
      }
    ]
  }
]

Changes