Skip to main content
GET
/
v0
/
ledgers
List all Ledgers
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/ledgers \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
import requests

url = "https://api.sandbox.teal.dev/v0/ledgers"

headers = {
    "teal-instance-id": "<teal-instance-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
  method: 'GET',
  headers: {'teal-instance-id': '<teal-instance-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.sandbox.teal.dev/v0/ledgers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.teal.dev/v0/ledgers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "teal-instance-id: <teal-instance-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.teal.dev/v0/ledgers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("teal-instance-id", "<teal-instance-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.sandbox.teal.dev/v0/ledgers")
  .header("teal-instance-id", "<teal-instance-id>")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.teal.dev/v0/ledgers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["teal-instance-id"] = '<teal-instance-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "id": "<string>",
      "name": "<string>",
      "editable": true,
      "is_required": true,
      "parent_id": null,
      "report_cash_flow": true,
      "sort_code": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "financial_account_type": "bank_account",
      "required_ledger_purpose": "account_transfers",
      "parent": "<unknown>"
    }
  ]
}
{
  "message": "<string>",
  "data": "<unknown>",
  "display_message": "<string>"
}
{
  "message": "<string>",
  "data": "<unknown>",
  "display_message": "<string>"
}
{
  "message": "<string>",
  "data": "<unknown>",
  "display_message": "<string>"
}
{
  "message": "<string>",
  "data": "<unknown>",
  "display_message": "<string>"
}

Authorizations

Authorization
string
header
required

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

Headers

teal-instance-id
string
required

The Teal instance ID

Query Parameters

type
enum<string> | null

Optional ledger type used for filtering.

Available options:
asset,
liability,
equity,
revenue,
expense
sub_type
enum<string> | null

Optional ledger sub type used for filtering.

Available options:
current_assets,
non-current_assets,
transfers_between_accounts,
uncategorized_assets,
current_liabilities,
non-current_liabilities,
equity,
operating_revenues,
other_income,
cost_of_goods_sold,
operating_expenses,
other_expenses,
retained_earnings
financial_account_type
enum<string> | null

Optional financial account type used for filtering.

Available options:
bank_account,
credit_card,
payments,
payroll,
loan,
prepaid_card,
accounts_receivable,
accounts_payable,
treasury,
investment
debit_credit
enum<string> | null

Optional ledger debit/credit used for filtering.

Available options:
debit,
credit
sort
enum<string>[] | null

A comma separated list of sort orders for the results.

Available options:
name,
-name,
type,
-type,
sub_type,
-sub_type,
debit_credit,
-debit_credit
expand
enum<string>[] | null

Comma-separated list of Ledger expand paths.

Available options:
parent,
parent.parent,
details
ledger_ids
string[] | null
deprecated

Deprecated: use ids instead. Comma-separated list of ledger IDs.

ids
string[] | null

Alias for ledger_ids. Comma-separated list of ledger IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized.

limit
integer
default:50

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

Required range: x >= 1
page_token
string | null

Opaque page token

Response

Successful Response

next_page_token
string | null
required

The token to use to request the next page

Example:

"ikal0NEVfMhF8dJf4yQ6KQZmGD"

prev_page_token
string | null
required

The token to use to request the previous page

Example:

"vuA7JeKI5c6FLnPt5JfRcZcJxW"

records
Ledger · object[]
required

List of ledgers

Example:
[
  {
    "created_at": "2024-01-01T00:00:00",
    "debit_credit": "debit",
    "editable": false,
    "financial_account_type": "bank_account",
    "id": "7JRNsKwy2Lw66caxVU7WGC",
    "is_autocat_category": false,
    "is_required": false,
    "name": "Pluto Checking 4242",
    "report_cash_flow": true,
    "sort_code": "2240",
    "sub_type": "current_assets",
    "type": "asset"
  }
]