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

# List a definition's schedules



## OpenAPI

````yaml /api-reference/specs/report.json get /report-definitions/{definitionId}/schedules
openapi: 3.0.1
info:
  title: Report Service
  description: Customisable reporting API for FlowPayroll.
  contact:
    name: FlowPayroll
    email: hello@flowpayroll.com
  version: v1
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1/report
security:
  - X-Auth-Token: []
    X-Org-Id: []
tags:
  - name: Datasets
    description: >-
      Discover what you can query: list the available datasets and inspect each
      field catalog — types, filterability, groupability, and supported
      aggregations.
  - name: Run reports
    description: >-
      Run a report synchronously — either an inline report definition or a saved
      one — and get columns and rows back in the response.
  - name: Report definitions
    description: >-
      Save a report definition under a name so it can be re-run, exported, and
      scheduled. Create, list, retrieve, replace, and delete definitions.
  - name: Exports
    description: >-
      Queue large result sets as asynchronous exports (CSV or JSONL, up to
      5,000,000 rows) and poll for a presigned download URL.
  - name: Schedules
    description: >-
      Run a saved definition on a cron schedule and deliver the export by
      webhook or email.
  - name: Run history
    description: Audit trail of every report run — synchronous, export, and scheduled.
paths:
  /report-definitions/{definitionId}/schedules:
    get:
      tags:
        - Schedules
      summary: List a definition's schedules
      operationId: listSchedules
      parameters:
        - $ref: '#/components/parameters/ScheduleDefinitionId'
      responses:
        '200':
          description: Schedules
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleListResponse'
        '401':
          $ref: '#/components/responses/Unauthorised'
components:
  parameters:
    ScheduleDefinitionId:
      name: definitionId
      in: path
      required: true
      schema:
        type: string
      description: Report definition id (ULID)
  schemas:
    ScheduleListResponse:
      type: object
      required:
        - schedules
      properties:
        schedules:
          type: array
          items:
            $ref: '#/components/schemas/ScheduleResponse'
    ScheduleResponse:
      type: object
      required:
        - scheduleId
        - definitionId
        - cron
        - timezone
        - format
        - delivery
        - enabled
        - nextDueAt
      properties:
        scheduleId:
          type: string
        definitionId:
          type: string
        cron:
          type: string
        timezone:
          type: string
        format:
          type: string
        delivery:
          $ref: '#/components/schemas/Delivery'
        enabled:
          type: boolean
        nextDueAt:
          type: string
          format: date-time
        webhookSecret:
          type: string
          nullable: true
          description: Returned exactly once, on creation — used to verify X-Flow-Signature
    ServiceError:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
        message:
          type: string
    Delivery:
      type: object
      properties:
        webhookUrl:
          type: string
          nullable: true
          description: HMAC-SHA256 signed (X-Flow-Signature) with the per-schedule secret
        emails:
          type: array
          items:
            type: string
          nullable: true
          description: Primary (To) recipients of the report-ready email
        cc:
          type: array
          items:
            type: string
          nullable: true
          description: Cc recipients of the report-ready email
        bcc:
          type: array
          items:
            type: string
          nullable: true
          description: Bcc recipients of the report-ready email
  responses:
    Unauthorised:
      description: No organisation context on the request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceError'
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      description: FlowPayroll JWT (raw token, no Bearer prefix)
      name: X-Auth-Token
      in: header
    X-Org-Id:
      type: apiKey
      description: >-
        Organisation to scope the request to. Required when the principal can
        access more than one organisation; optional for single-organisation
        principals (the authorizer resolves it automatically).
      name: X-Org-Id
      in: header

````