Get an account group by ID

GET/account-groups/{id}

A multi-entity group's position: every member entity's open accounts with balances, subtotals per entity and the group total

Path parameters

idstringRequired

Returns

200 OK

The Account Group object.

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

Request

curl -X GET 'https://api.dev.bank.corgi.com/account-groups/{id}' \
  -H "Authorization: Bearer $TOKEN"

Response200

{
  "available_amount": 10000,
  "currency_code": "USD",
  "entities": [
    {
      "accounts": [
        {}
      ],
      "available_amount": 10000,
      "customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "ledger_amount": 10000,
      "legal_name": "string",
      "role": "string"
    }
  ],
  "group_id": "string",
  "ledger_amount": 10000,
  "name": "string",
  "status": "string"
}