GET/entity

Retrieve or list accounts

With entity_id, retrieve one account and its balances. Without it, list every account in the program.

Query Parameters

entity_idstring

Account to retrieve; omit to list all

Example: "ent_0274ef47"

Request

GET/entity

curl --location 'https://api.ledgr.dev/v1/entity' \
--header 'Authorization: {api_key}'

Response

The account with balances

{
  "entity": {
    "status": "active",
    "balances": {
      "held": 0,
      "posted": 5000000,
      "pending": 0,
      "available": 5000000
    },
    "entity_id": "ent_0274ef47",
    "entity_name": "Treasury",
    "currency_code": "USD"
  },
  "status": "success"
}