---
title: "List scheduled report exports"
method: GET
path: "/v2/reports/{reportId}/schedules"
tags: ["Reports"]
---

# List scheduled report exports

`GET /v2/reports/{reportId}/schedules`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/reports/{reportId}/schedules`
- Auth: HTTP bearer

This endpoint retrieves a list of all scheduled exports for a specified report. These schedules represent planned events that can trigger exports based on various conditions and timings.

  ### Usage Notes
  - The **reportId** in the path parameter identifies the report whose scheduled exports are to be listed. Retrieve the **reportId** by calling the [/v2/reports](https://help.sigmacomputing.com/reference/list-reports) endpoint.
  - Use pagination query parameters to manage the volume of data returned by this endpoint.

  ### Usage Scenarios
  - **Schedule overview**: Administrators or users with appropriate permissions can monitor and review all active scheduled exports associated with a report.
  - **Audit and compliance**: This functionality is useful for auditing purposes to ensure that all scheduled operations are configured correctly and comply with organizational policies.

  ### Best Practices
  - Implement client-side handling to manage paginated data effectively, especially in cases where a report has a large number of scheduled exports.
  - Regularly audit schedules to keep them up-to-date and aligned with current workflows.

## Path parameters

- `reportId` string, required

## Query parameters

- `page` string
- `limit` number, double

## Response `200`

The response body.

- ReportsListReportSchedulesResponse200
  - `entries` V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItems[], required: Array of results returned by the endpoint
    - `scheduledNotificationId` string, required: Unique identifier of the scheduled export.
    - `reportId` string, required: Unique identifier of the report.
    - `schedule` V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsSchedule, required
      - `cronSpec` string, required: A [cron expression](https://en.wikipedia.org/wiki/Cron). For example, `0 0 * * *`.
      - `timezone` string, required: An [IANA timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, `America/Los_Angeles`.
    - `configV2` V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2, required
      - `title` string, required
      - `messageBody` string, required
      - `notificationAttachments` V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItems[], required
        - `formatOptions` union, required
          - V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions0
            - `type` 'PDF', required
            - `layout` 'portrait' | 'landscape'
            - `scaleFactor` number, double
          - V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions1
            - `type` 'NONE', required
        - `workbookExportSource` V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource
          - `type` 'report', required
      - `includeLink` boolean
      - `runAsRecipient` boolean
      - `attachmentSettings` V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2AttachmentSettings
        - `mergePdfAttachments` boolean
        - `zipAttachments` boolean
      - `conditionOptions` union
        - V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions0
          - `type` 'always', required
        - V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions1
          - `type` 'workbook', required
          - `conditions` V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems[], required
            - union
              - …
        - V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions2
          - `type` 'worksheet', required
          - `conditions` V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems[], required
            - union
              - …
        - V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions3
          - `type` 'dashboard', required
          - `conditions` V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems[], required
            - union
              - …
      - `alertConfig` V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2AlertConfig
        - `window` 'alltime' | 'daily' | 'weekly' | 'always', required
        - `volume` number, double, nullable
      - `notificationName` string
      - `reportSettings` V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ReportSettings
        - `filters` V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ReportSettingsFiltersItems[]
          - `id` string, required
          - `filterStr` string, required
        - `variableValues` union
          - DashVariables0
            - `type` 'boolean', required
            - `value` boolean, nullable, required
          - DashVariables1
            - `type` 'number', required
            - `value` number, double, nullable, required
          - DashVariables2
            - `type` 'text', required
            - `value` string, nullable, required
          - DashVariables3
            - `type` 'date', required
            - `value` union, required
              - …
          - DashVariables4
            - `type` 'number-list', required
            - `value` number[], required
          - DashVariables5
            - `type` 'text-list', required
            - `value` string[], required
          - DashVariables6
            - `type` 'date-list', required
            - `value` number[], required
          - DashVariables7
            - `type` 'boolean-list', required
            - `value` DashVariablesOneOf7Value, required
              - …
          - DashVariables8
            - `type` 'date-range', required
            - `min` union, required
              - …
            - `max` union, required
              - …
          - DashVariables9
            - `type` 'number-range', required
            - `min` number, double, nullable, required
            - `max` number, double, nullable, required
          - DashVariables10
            - `type` 'date-null', required
          - DashVariables11
            - `type` 'number-null', required
          - DashVariables12
            - `type` 'text-null', required
          - DashVariables13
            - `type` 'boolean-null', required
          - DashVariables14
            - `type` 'hierarchical-list', required
            - `value` string[], required
          - DashVariables15
            - `type` 'file', required
            - `value` DashVariablesOneOf15Value, required
              - …
          - DashVariables16
            - `type` 'file-null', required
          - DashVariables17
            - `type` 'file-list', required
            - `value` DashVariablesOneOf17ValueItems[], required
              - …
      - `dynamicExportSettings` V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettings
        - `variables` object
      - `dynamicRecipientSettings` V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicRecipientSettings
        - `sourceNodeId` string, required
        - `recipientColumnId` string, required
      - `rowLimit` number, double
      - `reportVariant` V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ReportVariant
        - `tagId` string
      - `embedOpts` V2ReportsReportIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2EmbedOpts
        - `embedId` string
        - `evalConnectionId` string
    - `isSuspended` boolean, required: Whether the schedule is currently suspended.
    - `ownerId` string, required: Unique identifier of the user who owns the schedule.
    - `lastUpdatedByUser` string, required: Unique identifier of the user who last updated the schedule.
    - `disabledAt` string, date-time, nullable, required: Timestamp when the schedule was disabled, or null if the schedule is active.
    - `disabledBy` string, nullable, required: Unique identifier of the member who disabled the schedule, or null if the schedule is active.
    - `createdBy` string, required: The identifier of the user who created this object.
    - `updatedBy` string, required: The identifier of the user or process that last updated this object.
    - `createdAt` string, date-time, required: When the object was created.
    - `updatedAt` string, date-time, required: When the object was last updated.
  - `nextPage` string, nullable, required: Returns a string that can be used as the `page` parameter in the next request to fetch the next page of results. The last page of results returns `null`.
  - `total` number, double: Total number of results. Useful to determine if there is a need to paginate.
  - `hasMore` boolean: **[Deprecated]** Indicates whether more results are available.

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)