about

Cron job endpoint

Firefly III has one endpoint for its various cron related tasks. Send a GET to this endpoint to run the cron. The cron requires the CLI token to be present. The cron job will fire for all users.

get/v1/cron/{cliToken}

Path parameters

cliTokenstring string required

Example:d5ea6b5fb774618dd6ad6ba6e0a7f55c

The CLI token of any user in Firefly III, required to run the cron job.

Query parameters

datestring date

Example:2026-08-01

A date formatted YYYY-MM-DD. This can be used to make the cron job pretend it's running on another day.

forceboolean

Forces the cron job to fire, regardless of whether it has fired before. This may result in double transactions or weird budgets, so be careful.

Headers

X-Trace-Idstring uuid

Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Response

The result of the cron job(s) firing.

Example response

{
  "recurring_transactions": {
    "job_fired": true,
    "job_succeeded": true,
    "message": "Cron result message"
  },
  "auto_budgets": {
    "job_fired": true,
    "job_succeeded": true,
    "message": "Cron result message"
  },
  "telemetry": {
    "job_fired": true,
    "job_succeeded": true,
    "message": "Cron result message"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.