Skip to main content
GET
List forecasts

Authorizations

Authorization
string
header
required

A workspace API key created in ThinkOut settings. One key reads one workspace.

Query Parameters

from
string<date>

Earliest date to include, inclusive.

to
string<date>

Latest date to include, inclusive.

category_id
string<uuid>[]

Only rows in these categories. Comma-separated for several. On /transactions this also matches a split transaction whose pieces are in one of them. Subcategories are included only on the summaries.

label_id
string<uuid>[]

Only rows carrying at least one of these labels. Comma-separated for several.

counterparty_id
string<uuid>[]

Only rows attributed to these counterparties. Comma-separated for several.

direction
enum<string>

Whether money comes in or goes out. On a transaction or forecast it follows the sign of amount.

Available options:
inflow,
outflow
status
enum<string>

realised is complete. partial has matched transactions. overdue is dated before today with none. planned is dated today or later with none.

Available options:
planned,
overdue,
partial,
realised
expand
enum<string>[]

Relations to return as objects instead of ids. Comma-separated. Expansion goes one level deep; an unknown name is rejected with invalid_expand.

Available options:
category,
counterparty,
labels,
recurrence,
linked_transactions
limit
integer
default:100

Page size. Outside the range it is rejected with limit_out_of_range.

Required range: 1 <= x <= 500
cursor
string

Opaque token from the previous page's next_cursor. Keep the other parameters unchanged between pages.

Response

A page of forecasts.

object
string
required
Allowed value: "list"
data
object[]
required
has_more
boolean
required

Whether another page exists.

next_cursor
string | null
required

Pass as cursor to fetch the next page. null on the last page.