> ## Documentation Index
> Fetch the complete documentation index at: https://docs.olostep.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 列出计划

> 检索您团队的所有计划。返回包含其配置、状态和元数据的计划列表。



## OpenAPI

````yaml zh/openapi/schedules.json GET /v1/schedules
openapi: 3.0.3
info:
  title: 调度 API
  version: 1.0.0
servers:
  - url: https://api.olostep.com
security: []
paths:
  /v1/schedules:
    get:
      summary: 列出计划
      description: 获取团队的所有计划。返回计划的列表，包括它们的配置、状态和元数据。默认情况下，已删除的计划会被过滤掉。
      parameters:
        - name: include_deleted
          in: query
          required: false
          description: 设置为 'true' 以在响应中包含已删除的计划。默认情况下，已删除的计划会被过滤掉。
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
            default: 'false'
      responses:
        '200':
          description: 成功响应包含计划列表。
          content:
            application/json:
              schema:
                type: object
                properties:
                  schedules:
                    type: array
                    items:
                      type: object
                      properties:
                        team_id:
                          type: string
                          description: 团队标识符
                        schedule_id:
                          type: string
                          description: 唯一的调度标识符
                        type:
                          type: string
                          enum:
                            - recurring
                            - onetime
                          description: 计划类型
                        endpoint:
                          type: string
                          description: 端点 URL
                        payload:
                          type: object
                          description: 随 API 调用发送的有效负载
                        cron_expression:
                          type: string
                          description: Cron 表达式（仅在重复调度中存在）
                        execute_at:
                          type: string
                          format: date-time
                          description: 执行日期时间（仅在一次性调度中存在）
                        expression_timezone:
                          type: string
                          description: 调度的时区
                        text:
                          type: string
                          description: 用于生成 cron 表达式的自然语言文本
                        schedule_name:
                          type: string
                          description: EventBridge 中的内部计划名称
                        schedule_group:
                          type: string
                          description: 计划组名称
                        created_at:
                          type: string
                          format: date-time
                          description: 调度创建时的 ISO 8601 日期时间
                        updated_at:
                          type: string
                          format: date-time
                          description: 计划最后更新的 ISO 8601 日期时间
                        state:
                          type: string
                          enum:
                            - ENABLED
                            - DELETED
                          description: 计划的当前状态
                        method:
                          type: string
                          enum:
                            - GET
                            - POST
                          description: 调度调用的 HTTP 方法
                    description: 计划对象的数组
                  count:
                    type: integer
                    description: 计划的总数
        '401':
          description: 无效的 API 密钥。
        '500':
          description: 获取计划时发生内部服务器错误。
      security:
        - Authorization: []
components:
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: Bearer认证头格式为Bearer <token>，其中<token>是你的认证令牌。

````