GET
/
v0
/
ledgers
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/ledgers \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "next_page_token": "<string>",
  "prev_page_token": "<string>",
  "records": [
    {
      "debit_credit": "debit",
      "editable": true,
      "financial_account_type": "bank_account",
      "id": "7JRNsKwy2Lw66caxVU7WGC",
      "is_required": true,
      "name": "Accounts Receivable",
      "parent": "<any>",
      "parent_id": "HLn8oy2eqMUCwjp1Cwdgco",
      "report_cash_flow": true,
      "sort_code": "2003",
      "sub_type": "current_assets",
      "type": "asset"
    }
  ]
}

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

teal-instance-id
string
required

Query Parameters

expand
enum<string>[] | null

Comma-separated list of Ledger expand paths.

Available options:
parent,
parent.parent
limit
integer | null

The number of records to return. Max limit is 1000.

page_token
string

Response

200 - application/json
next_page_token
string | null
required

The token to use to request the next page

prev_page_token
string | null
required

The token to use to request the previous page

records
object[]
required

List of ledgers