Skip to main content
List Balances
curl --request GET \
  --url http://127.0.0.1:3001/v1/organizations/{organization_id}/ledgers/{ledger_id}/balances \
  --header 'Content-Type: <content-type>'
{
  "items": [
    {
      "id": "<string>",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "alias": "<string>",
      "assetCode": "<string>",
      "available": 123,
      "onHold": 123,
      "scale": 123,
      "version": 123,
      "accountType": "<string>",
      "allowSending": true,
      "allowReceiving": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>",
  "limit": 123
}

Headers

​
Authorization
string

The authorization token. This header is required if your environment has the Access Manager enabled.

​
Content-Type
string
required

The type of media of the resource. Must be <code>application/json</code>.

​
X-Request-Id
string

A unique identifier used to trace and track each request.

Path Parameters

​
organization_id
string
required

The unique identifier of the Organization associated with the Ledger.

​
ledger_id
string
required

The unique identifier of the associated Ledger.

Query Parameters

​
limit
string
required

The maximum number of items to include in the response.

​
start_date
string

The beginning of the period you want to retrieve. You must also include the end_date.

​
end_date
string

The end of the period you want to retrieve. You must also include the start_date.

​
sort_order
string

The order used to sort the results.

​
cursor
string

The position in a dataset where the next page of results should start.

Response

Indicates that the request was successful and the response contains the expected data.

​
items
object[]
​
next_cursor
string

The position in a dataset of next page of results.

​
limit
integer

The maximum number of items included in the response.