---
title: "Get Schedule List"
method: GET
path: "/schedules"
tags: ["Schedules"]
---

# Get Schedule List

`GET /schedules`

Get a list of schedules

## Query parameters

- `filter` string — Filter query
- `page` integer — Page number
- `size` integer — Page size
- `sort` string — Sort options

## Response `200`

OK

- ControllersListResponseGithubModelsScheduleDTO
  - `data` ModelsScheduleDTO[]
    - `Schedule` ModelsSchedule — The data to update
      - `_id` string, objectid — ID
      - `cmd` string — Cmd
      - `created_at` string, date-time — Created timestamp
      - `created_by` string, objectid — Created by
      - `cron` string — Cron
      - `description` string — Description
      - `enabled` boolean — Enabled
      - `entry_id` integer — Entry ID
      - `execution_strategy` string — Execution Strategy
      - `mode` string — Mode
      - `name` string — Name
      - `node_group_ids` string[] — Node Group IDs
      - `node_ids` string[] — Node IDs
      - `param` string — Param
      - `priority` integer — Priority
      - `spider` ModelsSpider — The spider data to create
        - `_id` string, objectid — ID
        - `cmd` string — Execute command
        - `col_id` string, objectid — Data collection id
        - `col_name` string — Data collection name
        - `created_at` string, date-time — Created timestamp
        - `created_by` string, objectid — Created by
        - `database_id` string, objectid — Database Id
        - `db_name` string — Database name
        - `description` string — Description
        - `git_id` string, objectid — Related Git ID
        - `git_root_path` string — Git root path
        - `mode` 'random' | 'all' | 'selected-nodes' — Default task mode
        - `name` string — Spider name
        - `node_group_ids` string[] — Default node group ids, used in selected-node-groups mode
        - `node_ids` string[] — Default node ids, used in selected-nodes mode
        - `param` string — Default task param
        - `priority` integer — Priority
        - `project_id` string, objectid — Project ID
        - `template` string — Spider template
        - `template_params` ModelsSpiderTemplateParams — Spider template params
          - `allowed_domains` string — Allowed domains
          - `project_name` string — Project name
          - `spider_name` string — Spider name
          - `start_urls` string — Start urls
        - `updated_at` string, date-time — Updated timestamp
        - `updated_by` string, objectid — Updated by
      - `spider_id` string, objectid — Spider ID
      - `updated_at` string, date-time — Updated timestamp
      - `updated_by` string, objectid — Updated by
    - `spider` ModelsSpider — The spider data to create
      - `_id` string, objectid — ID
      - `cmd` string — Execute command
      - `col_id` string, objectid — Data collection id
      - `col_name` string — Data collection name
      - `created_at` string, date-time — Created timestamp
      - `created_by` string, objectid — Created by
      - `database_id` string, objectid — Database Id
      - `db_name` string — Database name
      - `description` string — Description
      - `git_id` string, objectid — Related Git ID
      - `git_root_path` string — Git root path
      - `mode` 'random' | 'all' | 'selected-nodes' — Default task mode
      - `name` string — Spider name
      - `node_group_ids` string[] — Default node group ids, used in selected-node-groups mode
      - `node_ids` string[] — Default node ids, used in selected-nodes mode
      - `param` string — Default task param
      - `priority` integer — Priority
      - `project_id` string, objectid — Project ID
      - `template` string — Spider template
      - `template_params` ModelsSpiderTemplateParams — Spider template params
        - `allowed_domains` string — Allowed domains
        - `project_name` string — Project name
        - `spider_name` string — Spider name
        - `start_urls` string — Start urls
      - `updated_at` string, date-time — Updated timestamp
      - `updated_by` string, objectid — Updated by
  - `error` string
  - `message` string
  - `status` string
  - `total` integer

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.net/crawlab-team/apis/crawlab-api.md) · [All operations](https://skmtc.net/crawlab-team/apis/crawlab-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crawlab-team/crawlab-api/versions/c7a4715c1f13/schema)