---
title: "GET /v1/schedule/"
method: GET
path: "/v1/schedule/"
tags: ["v1"]
---

# GET /v1/schedule/

`GET /v1/schedule/`

Retrieves the current schedule.

## Query parameters

- `search` string
- `ordering` string
- `limit` integer
- `offset` integer

## Response `200`

OK

- object
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` ScheduleEntry[], required
    - `self` string, uri — The url of the entry
    - `name` string, slug, required — [Required] The unique identifier used in URLs and filenames
    - `action` 'test_SEA_CBRS_Measure_Baseline' | 'test_monitor_sigan' | 'test_multi_frequency_iq_action' | 'test_single_frequency_iq_action' | 'test_single_frequency_m4s_action' | 'test_survey_iq_action' | 'test_sync_gps', required — [Required] The name of the action to be scheduled
    - `priority` integer, nullable — Lower number is higher priority (default=10)
    - `start` string, date-time, nullable — UTC time (ISO 8601) to start, or leave blank for 'now'
    - `stop` string, date-time, nullable — UTC time (ISO 8601) to stop, or leave blank for 'never' (not valid with relative stop)
    - `relative_stop` integer, nullable — Integer seconds after start to stop, or leave blank for 'never' (not valid with absolute stop)
    - `interval` integer, nullable — Seconds between tasks, or leave blank to run once
    - `is_active` boolean — Indicates whether the entry should be removed from the scheduler without removing it from the system
    - `callback_url` string, uri, nullable — If given, the scheduler will POST a `TaskResult` JSON object to this URL after each task completes
    - `next_task_time` string, date-time — UTC time (ISO 8601) the next task is scheduled for
    - `next_task_id` integer — The id of the next task to be executed
    - `created` string, date-time — The date the entry was created
    - `modified` string, date-time — The date the entry was modified
    - `owner` string, uri — The name of the user who owns the entry
    - `task_results` string — The list of results related to the entry
    - `validate_only` boolean — Only validate the input, do not modify the schedule

## Changes

- **2019-02-05** `f5baf16fe939` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/ntia/apis/scos-sensor-api/changes/v1/schedule/get.md)

---

[API](https://skmtc.dev/ntia/apis/scos-sensor-api.md) · [All operations](https://skmtc.dev/ntia/apis/scos-sensor-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ntia/scos-sensor-api/revisions/ccdf75254ca1/schema)
