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

# List Schedules



## OpenAPI

````yaml v1/api/actions.json get /schedules
openapi: 3.1.0
info:
  title: ED Automation External API
  description: This is the External API documentation for ED Automation
  version: dev
servers:
  - url: https://api.edges.run/v1
security:
  - XApiKeyAuth: []
paths:
  /schedules:
    get:
      tags:
        - public / schedules
      summary: Get scheduled runs
      operationId: getSchedules
      parameters:
        - schema:
            type: array
            items:
              type: string
              format: uuid
            minItems: 1
            nullable: true
          in: query
          name: uid
          required: false
          description: Scheduled run status
        - schema:
            type: array
            items:
              type: string
              enum:
                - ACTIVE
                - CANCELLED
                - PAUSED
                - COMPLETED
            minItems: 1
            nullable: true
          in: query
          name: status
          required: false
          description: Scheduled run status
        - schema:
            type: array
            items:
              type: string
              format: uuid
            minItems: 1
            nullable: true
          in: query
          name: user_uid
          required: false
          description: User UUID
        - schema:
            type: array
            items:
              type: string
              format: uuid
            minItems: 1
            nullable: true
          in: query
          name: workspace_uid
          required: false
          description: Workspace UUID
        - schema:
            type: array
            items:
              type: string
            minItems: 1
            nullable: true
          in: query
          name: action_name
          required: false
          description: Action name
        - schema:
            type: array
            items:
              type: string
              format: date-time
            minItems: 1
            nullable: true
          in: query
          name: next_execution_at
          required: false
          description: Next execution at
        - schema:
            type: array
            items:
              type: string
              format: date-time
            minItems: 1
            nullable: true
          in: query
          name: last_executed_at
          required: false
          description: Last executed at
        - schema:
            type: array
            items:
              type: string
              format: date-time
            minItems: 1
            nullable: true
          in: query
          name: created_at
          required: false
          description: Created at
        - schema:
            type: array
            items:
              type: string
              format: date-time
            minItems: 1
            nullable: true
          in: query
          name: updated_at
          required: false
          description: Updated at
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
          in: query
          name: limit
          required: false
        - schema:
            type: integer
            minimum: 0
            default: 0
          in: query
          name: offset
          required: false
        - schema:
            type: array
            items:
              type: string
              maxLength: 128
            default:
              - created_at
            maxItems: 10
          examples:
            example1:
              value:
                - '-next_execution_at, status'
            example2:
              value:
                - '-created_at'
                - status
            example3:
              value:
                - updated_at
            example4:
              value:
                - '-action_name'
          in: query
          name: sort
          required: false
          description: >-
            Sort by fields. Prefix with `-` for descending order. Default is
            ascending order.
      responses:
        '200':
          description: Returns the scheduled runs
          content:
            application/json:
              schema:
                description: Returns the scheduled runs
                type: array
                items:
                  type: object
                  properties:
                    uid:
                      type: string
                      format: uuid
                      description: Scheduled Run UUID
                    name:
                      type: string
                      description: Optional user-defined label for the scheduled run.
                      maxLength: 255
                      nullable: true
                    action_id:
                      type: integer
                      description: Action ID
                    action_name:
                      type: string
                      description: Action name
                    user_uid:
                      type: string
                      format: uuid
                      description: Member/User UUID
                    workspace_uid:
                      type: string
                      format: uuid
                      description: Workspace UUID
                    status:
                      type: string
                      enum:
                        - ACTIVE
                        - CANCELLED
                        - PAUSED
                        - COMPLETED
                      nullable: true
                      description: Scheduled run status
                    postponed_until:
                      type: string
                      format: date-time
                      nullable: true
                      description: >-
                        If the run is postponed, this field indicates when it
                        will be retried.
                    cron:
                      type: string
                      description: Cron expression for the scheduled run (POSIX format)
                      nullable: true
                    timezone:
                      type: string
                      description: Timezone for the scheduled run (IANA timezone format)
                      nullable: true
                    next_execution_at:
                      type: string
                      format: date-time
                      nullable: true
                      description: Next execution at
                    last_executed_at:
                      type: string
                      format: date-time
                      description: Last executed at
                      nullable: true
                    created_at:
                      type: string
                      format: date-time
                      description: Created at
                      nullable: true
                    updated_at:
                      type: string
                      format: date-time
                      description: Updated at
                      nullable: true
                    parameters:
                      type: object
                      additionalProperties: false
                      properties:
                        sync_mode:
                          type: string
                          enum:
                            - full
                            - incremental
                          default: full
                          title: Synchronization Mode
                          description: >-
                            Controls how data is fetched. `full` retrieves all
                            available data (limited by `max_results`).
                            `incremental` retrieves only new data since the last
                            processed item. Incremental runs can be continued
                            using `/v1/runs/{run_uid}/continue`.
                  additionalProperties: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/def-0'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/def-0'
components:
  schemas:
    def-0:
      title: APIError
      description: >-
        Represents an error returned by the API. This schema defines the
        standard structure of error messages to ensure consistent error handling
        across the application.
      type: object
      properties:
        error_label:
          type: string
          nullable: true
        error_scope:
          type: string
          enum:
            - input
            - integ
            - param
            - config
          nullable: true
        error_ref:
          type: string
          nullable: true
          example: ERR-12345
        message:
          type: string
        status_code:
          type: integer
          nullable: true
        params:
          type: object
          additionalProperties:
            anyOf:
              - type: string
              - type: number
              - type: boolean
              - type: 'null'
              - type: array
                items:
                  type: string
          nullable: true
        data:
          type: object
          nullable: true
          additionalProperties: true
          description: Additional data about the error
      additionalProperties: false
  securitySchemes:
    XApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````