Skip to main content
GET
List cash flow targets

Authorizations

Authorization
string
header
required

Bearer authorization header: Bearer <token>, where <token> is the access token received from the authorization server at the end of the OAuth 2.0 flow.

Headers

X-Qonto-Staging-Token
string

Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.

Query Parameters

scenario_id
string

Scenario ID filter. Defaults to the organization's main scenario when omitted.

Example:

"019259fb-8731-767a-b8fd-9206aa052e3d"

category_id
string

Category ID filter. When omitted, targets for all categories are returned.

Example:

"3786f44c-a2e1-472e-870d-4cdb152b33fa"

from_year
integer

Start year of the period range (inclusive). When omitted along with from_month, to_year, and to_month, defaults to the current year.

Example:

2025

from_month
integer

Start month of the period range (inclusive, 1-12). When omitted along with from_year, to_year, and to_month, defaults to the current month.

Example:

1

to_year
integer

End year of the period range (inclusive). When omitted along with to_month, from_year, and from_month, defaults to the same month next year.

Example:

2025

to_month
integer

End month of the period range (inclusive, 1-12). When omitted along with to_year, from_year, and from_month, defaults to the same month next year.

Example:

12

page
integer
default:1

Returned page (cf. Pagination).

per_page
integer
default:25

Number of targets per page. Default 25, max 1000 (cf. Pagination).

Response

Returns the targets matching the supplied filters.

cash_flow_targets
object[]
required
meta
object
required

Metadata for paginated responses