---
title: "Cron job endpoint"
method: GET
path: "/v1/cron/{cliToken}"
tags: ["about"]
---

# Cron job endpoint

`GET /v1/cron/{cliToken}`

## Request

- Base URL: `https://demo.firefly-iii.org/api`
- URL: `https://demo.firefly-iii.org/api/v1/cron/{cliToken}`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://demo.firefly-iii.org/oauth/authorize`
    - Token URL: `https://demo.firefly-iii.org/oauth/token`
  - HTTP bearer

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.

## Path parameters

- `cliToken` string, string, required

## Query parameters

- `date` string, date
- `force` boolean

## Headers

- `X-Trace-Id` string, uuid

## Response `200`

The result of the cron job(s) firing.

- CronResult
  - `recurring_transactions` CronResultRow
    - `job_fired` boolean, nullable: This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs only fire every 24 hours, for example.
    - `job_succeeded` boolean, nullable: This value tells you if this specific cron job actually did something. The job may fire but not change anything.
    - `job_errored` boolean, nullable: If the cron job ran into some kind of an error, this value will be true.
    - `message` string, string, nullable: If the cron job ran into some kind of an error, this value will be the error message. The success message if the job actually ran OK.
  - `auto_budgets` CronResultRow
    - `job_fired` boolean, nullable: This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs only fire every 24 hours, for example.
    - `job_succeeded` boolean, nullable: This value tells you if this specific cron job actually did something. The job may fire but not change anything.
    - `job_errored` boolean, nullable: If the cron job ran into some kind of an error, this value will be true.
    - `message` string, string, nullable: If the cron job ran into some kind of an error, this value will be the error message. The success message if the job actually ran OK.
  - `telemetry` CronResultRow
    - `job_fired` boolean, nullable: This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs only fire every 24 hours, for example.
    - `job_succeeded` boolean, nullable: This value tells you if this specific cron job actually did something. The job may fire but not change anything.
    - `job_errored` boolean, nullable: If the cron job ran into some kind of an error, this value will be true.
    - `message` string, string, nullable: If the cron job ran into some kind of an error, this value will be the error message. The success message if the job actually ran OK.

## Other responses

- `400`: Bad request
- `401`: Unauthenticated
- `404`: Page not found
- `422`: Validation error. The body will have the exact details.
- `500`: Internal exception

---

[API](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-5-5.md) - [All operations](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-5-5/llms.txt) - [OpenAPI document](https://skmtc.dev/firefly-iii/apis/firefly-iii-api-v6-5-5/revisions/906276730447?raw)