Skip to main content
GET
/
v2
/
ledger-accounts
List Ledger Accounts
curl --request GET \
  --url https://api.example.com/v2/ledger-accounts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "classification": "asset",
      "currency": "ADP",
      "current_balance": "<string>",
      "description": "<string>",
      "is_active": true,
      "is_direct_posting_enabled": true,
      "name": "<string>",
      "number": "<string>",
      "parent_account_id": "<string>",
      "remote_id": "<string>",
      "subtype": "<string>",
      "type": "<string>",
      "object": "<string>"
    }
  ],
  "current_page": 0,
  "total_records": 1,
  "next_page": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
default:0

Page number, 0 indexed.

Required range: x >= 0
​
limit
integer
default:100

Number of records per page.

Required range: 1 <= x <= 500
​
classification
enum<string>
Available options:
asset,
equity,
expense,
liability,
revenue,
other
​
search
string

Response

Successful Response

​
data
LedgerAccount · object[]
required

The list of records.

​
current_page
integer
default:0
required

The current page.

​
total_records
integer | null
required

Total number of records.

Required range: x >= 0
​
next_page
integer | null
required

The next page number, if one exists.