---
title: "Gets a new blank scheduler object"
method: GET
path: "/api/v1/task_schedulers/create"
tags: ["task_schedulers"]
---

# Gets a new blank scheduler object

`GET /api/v1/task_schedulers/create`

## Request

- Base URL: `https://demo.invoiceninja.com`
- URL: `https://demo.invoiceninja.com/api/v1/task_schedulers/create`
- Auth: none declared. Required headers: `X-API-TOKEN`, `X-Requested-With`
- TypeScript: <https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/docs/api/v1/task_schedulers/create/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a blank object with default values

## Query parameters

- `include` string
- `per_page` integer
- `page` integer

## Headers

- `X-API-TOKEN` string, required
- `X-Requested-With` string, required

## Response `200`

A blank scheduler object

- TaskSchedulerSchema
  - `paused` boolean: The scheduler paused state
  - `repeat_every` string: Accepted values (DAY,WEEK,MONTH,3MONTHS,YEAR)
  - `start_from` integer: Timestamp when we should start the scheduler, default is today
  - `job` string: Job, we can find list of available jobs in Scheduler model
  - `date_range` string: The string representation of the date range of data to be returned
  - `date_key` string: The date column to search between.
  - `start_date` string: The start date to search between
  - `end_date` string: The end date to search between
  - `report_keys` string[]

## Other responses

- `401`: Authentication error
- `403`: Authorization error
- `422`: Validation error
- `default`: Unexpected Error

## Changes

- **2026-04-20** `69a36036d334`: 2 info
  - added the new optional `query` request parameter `page`
  - added the new optional `query` request parameter `per_page`
- **2024-06-06** `8e82a2bd77e0`: 1 breaking, 2 info
  - the response's body type changed from no type to `object` for status `default`
  - added the optional property `code` to the response with the `default` status
  - added the optional property `message` to the response with the `default` status
- **2024-06-05** `e61df65649e2`: 1 breaking, 2 warning
  - the response's body type changed from `object` to no type for status `default`
  - removed the optional property `code` from the response with the `default` status
  - removed the optional property `message` from the response with the `default` status
- **2024-03-07** `71171a40d629`: 5 breaking, 16 info
  - the response's body type changed from no type to `object` for status `200`
  - the response's body type changed from no type to `object` for status `401`
  - the response's body type changed from no type to `object` for status `403`
  - the response's body type changed from no type to `object` for status `422`
  - …17 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/changes/api/v1/task_schedulers/create/get.md)

---

[API](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference.md) - [All operations](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/revisions/bcda1f823746?raw)