---
title: "List prompt schedules"
method: GET
path: "/api/v1/prompt-schedules"
tags: ["Basics"]
---

# List prompt schedules

`GET /api/v1/prompt-schedules`

## Request

- Base URL: `https://api.athenahq.ai`
- URL: `https://api.athenahq.ai/api/v1/prompt-schedules`
- Auth: API key in header `x-api-key`

List Default, custom and archived streaming schedules for a website. Use each row's selection value when filtering analytics or responses. Default includes all pre-cutover history and ad hoc runs. Select one schedule at a time; archived schedules retain results. Filters take one schedule; the metrics endpoints combine the schedules of a saved view stored with several schedules.

## Query parameters

- `website_id` string, uuid, required

## Response `200`

Success

- object
  - `schedules` object[], required
    - `id` string, required
    - `name` string, required
    - `kind` 'default' | 'custom', required
    - `selection` union, required
      - 'default'
      - string
    - `is_active` boolean, required
    - `archived_at` string, nullable, required
    - `starts_on` string, date, nullable, required: First UTC calendar day (YYYY-MM-DD) a custom schedule fires. Null means no lower bound. Always null on Default.
    - `ends_on` string, date, nullable, required: Last UTC calendar day (YYYY-MM-DD) a custom schedule fires. Null means no upper bound. An active schedule past this day does not run. Always null on Default.

## Other responses

- `400`: Bad Request — validation failed
- `401`: Unauthenticated
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `429`: Rate Limited
- `500`: Internal Error

## Changes

- **2026-11-03** `2d1d86d5e067`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/athenahq/apis/athenahq-api/changes/api/v1/prompt-schedules/get.md)

---

[API](https://skmtc.dev/athenahq/apis/athenahq-api.md) - [All operations](https://skmtc.dev/athenahq/apis/athenahq-api/llms.txt) - [OpenAPI document](https://skmtc.dev/athenahq/apis/athenahq-api/revisions/6cf9ca58edf6?raw)