List Accounts

Use this endpoint to list all accounts in your Ledger.

GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts

List Accounts

cURL

curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts

200

Example

{ "items": [ { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "assetCode": "<string>", "name": "<string>", "alias": "<string>", "type": "<string>", "blocked": false, "parentAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "entityId": "<string>", "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "status": "<unknown>", "metadata": {}, "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "deletedAt": "2023-11-07T05:31:56Z" } ], "page": 123, "limit": 123 }

Headers

Authorization · string

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

Content-Type · string

The type of media of the resource. Recommended value is application/json.

X-Request-Id · string<uuid>

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

The maximum number of items to include in the response. Max: 100

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.

page · string

The number of the page that you want to retrieve.

portfolio_id · string<uuid>

Filter accounts by portfolio. Returns only accounts assigned to this portfolio.

segment_id · string<uuid>

Filter accounts by segment. Returns only accounts assigned to this segment.

status · enum<string>

Filter accounts by status. Accepted values are active, blocked, or inactive.

Available options: active, blocked, inactive

type · string

Filter accounts by type (exact match, case-insensitive). Common values include deposit, savings, loans, marketplace, creditCard, and external.

asset_code · string

Filter accounts by asset code (e.g. BRL, USD).

entity_id · string

Filter accounts by entity identifier.

blocked · boolean

Filter accounts by blocked state. Use true to list only blocked accounts, false for unblocked.

parent_account_id · string<uuid>

Filter accounts by parent account. Returns only sub-accounts of the specified parent.

name · string

Filter accounts by name. Uses prefix matching (case-insensitive).

alias · string

Filter accounts by alias. Uses prefix matching (case-insensitive).

metadata.key · string

Filter by metadata using dot-notation. Replace key with your metadata field name (e.g. metadata.costCenter=BR_11101997).

Response

200

application/json

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

items · object[]

Show child attributes

page · integer

The number of pages returned.

limit · integer

The maximum number of items included in the response.