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

# List Upcoming Scheduled Occurrences

> Use this endpoint to list the next occurrences across the workflow's enabled schedule triggers, merged by time and tagged with the trigger that fires each, in each schedule's timezone. It answers 422 when the workflow has no schedule trigger, and an empty list when every one is disabled.



## OpenAPI

````yaml /pt/openapi/v3-current/flowker.yaml get /v1/workflows/{id}/schedule/upcoming
openapi: 3.1.0
info:
  description: >-
    Complete API reference for Flowker workflow orchestration services including
    catalog management, workflow definitions, executor configurations, provider
    configurations, and workflow executions.
  title: Flowker API
  version: 1.5.0
servers:
  - url: https://flowker.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - name: Catalog API
    description: >-
      Browse built-in providers, executors, and triggers available in the
      Flowker catalog.
  - name: Workflows API
    description: >-
      Create, update, activate, deactivate, clone, and delete workflow
      definitions.
  - name: Executions API
    description: Start workflow executions and track their status and results.
  - name: Executor Configurations API
    description: >-
      List, inspect, update, and delete the executor configuration records a
      deployment holds.
  - name: Provider Configurations API
    description: >-
      Create, update, enable, and disable the provider configurations that
      workflow nodes call through.
  - name: Dashboard API
    description: >-
      Retrieve aggregated summaries of workflows and executions for operational
      dashboards.
  - name: Webhooks API
    description: >-
      Receive webhook callbacks from external systems to trigger workflow
      executions.
  - name: Schedule API
    description: >-
      Inspect a workflow's upcoming, skipped, and parked scheduled occurrences,
      and run or discard the parked ones.
  - name: Schema Registry API
    description: >-
      Publish global OpenAPI specification versions for native services and pin
      the version each tenant resolves against.
  - name: OpenAPI Schemas API
    description: >-
      Upload, inspect, and delete the tenant's external OpenAPI schemas, and
      derive the contract of a single operation.
  - name: XSD Schemas API
    description: >-
      Upload, inspect, and delete the tenant's XSD schemas used to validate XML
      webhook payloads.
  - name: Settings API
    description: >-
      Read and set per-client settings, such as how long Flowker keeps finished
      executions.
paths:
  /v1/workflows/{id}/schedule/upcoming:
    get:
      tags:
        - Schedule API
      summary: List Upcoming Scheduled Occurrences
      description: >-
        Use this endpoint to list the next occurrences across the workflow's
        enabled schedule triggers, merged by time and tagged with the trigger
        that fires each, in each schedule's timezone. It answers 422 when the
        workflow has no schedule trigger, and an empty list when every one is
        disabled.
      operationId: listWorkflowScheduleUpcoming
      parameters:
        - description: Workflow identifier (UUID).
          in: path
          name: id
          required: true
          schema:
            description: Workflow identifier (UUID).
            type: string
            example: 018f3e2a-1c4d-7b9e-a1b2-c3d4e5f6a7b8
        - description: Number of occurrences to compute (1-50; default 10).
          explode: false
          in: query
          name: limit
          schema:
            description: Number of occurrences to compute (1-50; default 10).
            type: string
            example: '10'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpcomingOccurrencesOutput'
          description: >-
            Indicates that the request was successful and the response contains
            the requested data.
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indicates that the request failed. The body is an RFC 9457 problem
            document.
components:
  schemas:
    UpcomingOccurrencesOutput:
      additionalProperties: false
      properties:
        occurrences:
          items:
            $ref: '#/components/schemas/UpcomingOccurrenceOutput'
          type:
            - array
            - 'null'
      required:
        - occurrences
      type: object
    ErrorResponse:
      properties:
        code:
          description: Stable, machine-readable Flowker error code.
          example: FLK-0001
          type: string
        detail:
          description: >-
            Human-readable explanation of this occurrence. Responses with a
            status of 500 or above carry a fixed generic message.
          example: name is a required field
          type: string
        errors:
          description: Per-field entries for a request that failed validation.
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
        instance:
          description: URI reference identifying this specific occurrence.
          example: /v1/workflows
          format: uri
          type: string
        status:
          description: HTTP status code.
          example: 400
          type: integer
        title:
          description: >-
            Standard HTTP reason phrase for the status. It does not change per
            error code.
          example: Bad Request
          type: string
        type:
          description: >-
            URI reference identifying the error. Always the error catalog base
            followed by the code.
          example: https://errors.lerian.studio/v1/FLK-0001
          format: uri
          type: string
      type: object
    UpcomingOccurrenceOutput:
      additionalProperties: false
      properties:
        scheduledFor:
          format: date-time
          type: string
          example: '2026-01-15T10:30:00Z'
        triggerNodeId:
          type: string
          example: trigger-1
          description: The schedule trigger this occurrence belongs to.
      required:
        - scheduledFor
        - triggerNodeId
      type: object
    ErrorDetail:
      properties:
        location:
          description: Where the problem is, such as body.nodes or path.id.
          example: body.nodes
          type: string
        message:
          description: Description of the field-level problem.
          example: expected array length >= 1
          type: string
        value:
          description: The value that caused the error, when it is safe to echo.
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT bearer token issued by the identity provider. Send it in the
        Authorization header as `Bearer <token>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.