---
updatedAt: 2026-05-12T09:58:37.000Z
---

# Retrieve schedules

This operation returns an object containing a list all active schedules for assets the user has permission to access.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Schedule API (Legacy)",
    "license": {
      "name": "(c) Copyright 2020 WhiteHat Security"
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com"
    }
  ],
  "paths": {
    "/api/schedule": {
      "get": {
        "tags": [
          "Schedule API v1.0"
        ],
        "summary": "Retrieve schedules",
        "description": "This operation returns an object containing a list all active schedules for assets the user has permission to access.",
        "operationId": "getListOfSchedules",
        "parameters": [
          {
            "name": "name",
            "in": "query",
            "description": "Query by schedule name. Returns schedules with the given name.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "start_date",
            "in": "query",
            "description": "Query by start date. The start date is the date the schedule was created. Format: YYYY-MM-DDThh:mm:ss. EXAMPLE: 2017-01-01T00:00:00 will find all schedules with a start_date of midnight on January 1, 2017.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "duration",
            "in": "query",
            "description": "Query by the time duration in seconds.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "timezone",
            "in": "query",
            "description": "Query by the time zone of schedule. EXAMPLE: America/New_York",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "job",
            "in": "query",
            "description": "Query by the job ID of the schedule.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "creator",
            "in": "query",
            "description": "Query by the schedule creator's ID. Returns schedules created by the given user for assets the requester can access.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "format",
            "in": "query",
            "description": "Format of results.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "xml",
              "example": "json",
              "enum": [
                "json",
                "xml"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Provides list of all active schedules.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScheduleCollection"
                }
              },
              "application/xml": {
                "example": "XML preview is currently not supported."
              }
            }
          },
          "400": {
            "description": "BadRequestResponse indicates a request with invalid parameters.",
            "content": {}
          },
          "401": {
            "description": "UnauthorizedResponse signals an unauthorized API access.",
            "content": {}
          },
          "403": {
            "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized.",
            "content": {}
          },
          "500": {
            "description": "GenericError generic error.",
            "content": {}
          }
        },
        "deprecated": false
      }
    }
  },
  "components": {
    "schemas": {
      "Schedule": {
        "properties": {
          "href": {
            "type": "string"
          },
          "timezone": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "start_date": {
            "type": "string",
            "nullable": true
          },
          "creator": {
            "type": "string",
            "nullable": true
          },
          "api-version": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "job": {
            "properties": {
              "id": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "specs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                },
                "cron_spec": {
                  "type": "string"
                },
                "duration": {
                  "type": "number",
                  "nullable": true
                },
                "time": {
                  "type": "string",
                  "nullable": true
                },
                "weekday": {
                  "type": "string",
                  "nullable": true
                }
              }
            }
          }
        }
      },
      "ScheduleCollection": {
        "properties": {
          "type": {
            "type": "string"
          },
          "href": {
            "type": "string"
          },
          "stats": {
            "properties": {
              "query_total": {
                "type": "number"
              }
            },
            "type": "object"
          },
          "collection": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Schedule"
            }
          }
        }
      }
    }
  },
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```