---
title: "GET /api/jobs/schedules/{id}"
method: GET
path: "/api/jobs/schedules/{id}"
tags: ["api", "jobs"]
---

# GET /api/jobs/schedules/{id}

`GET /api/jobs/schedules/{id}`

Get a Scheduled Job

## Path parameters

- `id` union, required
  - string
  - string

## Response `200`

OK

- GETJobsGetAScheduledJob200Response
  - `_id` string, required — The ID of the scheduled job
  - `name` string — The name of the scheduled job
  - `sellerId` string, required — The ID of the seller of the scheduled job.
  - `timezone` string, required — The timezone of the scheduled job.
  - `scheduleFrequency` union — The schedule specification of the sheduled job.
    - object
      - `interval` 'WEEK', required
      - `every` integer, required — The recurrence of the scheduled job.
      - `time` object — The time when scheduled job should be executed.
        - `hour` integer, required
        - `minute` integer, required
      - `endAt` string, date-time — An ISO Timestamp indicating when the last execution of the scheduled job should occur.
      - `repeatsOn` string[], required
    - object
      - `every` integer, required — The recurrence of the scheduled job.
      - `time` object — The time when scheduled job should be executed.
        - `hour` integer, required
        - `minute` integer, required
      - `endAt` string, date-time — An ISO Timestamp indicating when the last execution of the scheduled job should occur.
      - `interval` 'DAY' | 'MONTH', required — The interval of the scheduled job.
  - `task` union — The task specification of the scheduled job.
    - object
      - `type` 'report' | 'dashboard', required — The type of the task.
      - `mail` object, required
        - `to` string[] — The array of mail recipients.
      - `timeWindow` union
        - object
          - `mode` 'ROLLING_WINDOW', required
          - `range` object, required
            - `interval` integer, required
            - `unit` 'DAY' | 'WEEK' | 'MONTH' | 'YEAR', required
            - `offset` integer, required
        - object
          - `mode` 'EQUAL_TO_FREQUENCY', required — The mode of the time window.
      - `reportTemplateId` string, required — The ID of the template report.
      - `reportType` string, required — The type of the template report.
      - `config` object — The configuration object of the report.
        - `hideFilters` boolean
    - object
      - `type` 'dashboard', required — The type of the task.
      - `mail` object, required
        - `to` string[] — The array of mail recipients.
      - `timeWindow` union
        - object
          - `mode` 'ROLLING_WINDOW', required
          - `range` object, required
            - `interval` integer, required
            - `unit` 'DAY' | 'WEEK' | 'MONTH' | 'YEAR', required
            - `offset` integer, required
        - object
          - `mode` 'EQUAL_TO_FREQUENCY', required — The mode of the time window.
      - `dashboardId` string, required — The ID of the dashboard.
  - `createdBy` object — The entity that created this scheduled job.
    - `type` 'USER' | 'APP' | 'API_KEY' | 'SYSTEM', required — The type of the entity
    - `id` string, required — The ID of the entity
  - `createdAt` string, date-time, required — An ISO Timestamp indicating when the resource was created.
  - `updatedAt` string, date-time, required — An ISO Timestamp indicating when the resource was updated.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

[API](https://skmtc.net/vivenu/apis/vivenu-api.md) · [All operations](https://skmtc.net/vivenu/apis/vivenu-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vivenu/vivenu-api/revisions/36be0dca14e7/schema)