Skip to main content
GET
/
ledger-accounts
List Ledger Accounts
curl --request GET \
  --url https://api.atlas.co/functions/v1/ledger-accounts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "account_number": "<string>",
      "name": "<string>",
      "description": "<string>",
      "account_type": "asset",
      "normal_balance": "<string>",
      "status": "active",
      "currency": "<string>",
      "balance": 123,
      "available_balance": 123,
      "pending_balance": 123,
      "balance_updated_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "external_reference": "<string>",
      "is_system_account": true,
      "created_at": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "has_more": true
  }
}

Authorizations

Authorization
string
header
required

API key (sk_test_* or sk_live_*)

Query Parameters

limit
integer
default:10
Required range: x <= 100
offset
integer
default:0
account_type
enum<string>
Available options:
asset,
liability,
equity,
revenue,
expense
status
enum<string>
Available options:
active,
frozen,
closed
customer_id
string

Response

200 - application/json

Account list

data
object[]
pagination
object