GET
/
v0
/
transfers
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "id": "3VWKZudFv7opyvMq8JrRyD",
      "from_journal_entry_id": "5zpFhGyJBawsTYMC42ktyi",
      "from_journal_entry": {
        "id": "C4ocnUQze8kDwQ3EczkZXn",
        "description": "Payroll#230215",
        "datetime": "2023-02-15T06:42:18Z",
        "files": null,
        "line_entry_ids": [
          "XMDsKVuW4Wmi3LTW31Qw6E",
          "NULcvXTkLczde32qs1rqgB"
        ],
        "linked_entity": {
          "type": "receivable",
          "id": "<string>"
        },
        "line_entries": [
          {
            "amount": 31282.28,
            "datetime": "2023-02-15T06:42:18Z",
            "debit_credit": "debit",
            "description": "Payroll#230215",
            "editable": false,
            "id": "XMDsKVuW4Wmi3LTW31Qw6E",
            "journal_entry_description": "Payroll#230215",
            "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
            "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
            "ledger_name": "Pluto Checking 4242",
            "tags": [],
            "transaction_id": "txn_UjL3BQnEaJtecuC7CUeDk"
          },
          {
            "amount": 31282.28,
            "datetime": "2023-02-15T06:42:18Z",
            "debit_credit": "credit",
            "description": "Payroll#230215",
            "editable": false,
            "id": "NULcvXTkLczde32qs1rqgB",
            "journal_entry_description": "Payroll#230215",
            "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
            "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
            "ledger_name": "Payroll Expense",
            "tags": []
          }
        ]
      },
      "to_journal_entry_id": "SvanUJEjPRHC38zYLEKGMZ",
      "to_journal_entry": {
        "id": "C4ocnUQze8kDwQ3EczkZXn",
        "description": "Payroll#230215",
        "datetime": "2023-02-15T06:42:18Z",
        "files": null,
        "line_entry_ids": [
          "XMDsKVuW4Wmi3LTW31Qw6E",
          "NULcvXTkLczde32qs1rqgB"
        ],
        "linked_entity": {
          "type": "receivable",
          "id": "<string>"
        },
        "line_entries": [
          {
            "amount": 31282.28,
            "datetime": "2023-02-15T06:42:18Z",
            "debit_credit": "debit",
            "description": "Payroll#230215",
            "editable": false,
            "id": "XMDsKVuW4Wmi3LTW31Qw6E",
            "journal_entry_description": "Payroll#230215",
            "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
            "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
            "ledger_name": "Pluto Checking 4242",
            "tags": [],
            "transaction_id": "txn_UjL3BQnEaJtecuC7CUeDk"
          },
          {
            "amount": 31282.28,
            "datetime": "2023-02-15T06:42:18Z",
            "debit_credit": "credit",
            "description": "Payroll#230215",
            "editable": false,
            "id": "NULcvXTkLczde32qs1rqgB",
            "journal_entry_description": "Payroll#230215",
            "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
            "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
            "ledger_name": "Payroll Expense",
            "tags": []
          }
        ]
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
teal-instance-id
string
required

The Teal instance ID

Query Parameters

​
from_ledger_id
string

The Transfer's originating ledger id

​
to_ledger_id
string | null

The Transfer's destination ledger id

​
expand
enum<string>[] | null

Comma-separated list of Transfer expand paths.

​
limit
integer | null
default:50

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

Required range: 1 <= x < 101
​
page_token
string | null

Response

200
application/json

Successful Response

The response is of type object.