> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://help.sigmacomputing.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server.

# List scheduled report exports

GET https://api.sigmacomputing.com/v2/reports/{reportId}/schedules

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.

Reference: https://help.sigmacomputing.com/reference/list-report-schedules

## Authentication

- OAuth2 — send the obtained token as `Authorization: Bearer <token>`

## Servers

- `https://api.sigmacomputing.com` (Server for GCP (US) hosted organizations, default)
- `https://api.sa.gcp.sigmacomputing.com` (Server for GCP (KSA) hosted organizations)
- `https://aws-api.sigmacomputing.com` (Server for AWS US (West) hosted organizations)
- `https://api.us-a.aws.sigmacomputing.com` (Server for AWS US (East) hosted organizations)
- `https://api.ca.aws.sigmacomputing.com` (Server for AWS Canada hosted organizations)
- `https://api.eu.aws.sigmacomputing.com` (Server for AWS Europe hosted organizations)
- `https://api.au.aws.sigmacomputing.com` (Server for AWS Australia and APAC hosted organizations)
- `https://api.uk.aws.sigmacomputing.com` (Server for AWS UK hosted organizations)
- `https://api.us.azure.sigmacomputing.com` (Server for Azure US hosted organizations)
- `https://api.eu.azure.sigmacomputing.com` (Server for Azure Europe hosted organizations)
- `https://api.ca.azure.sigmacomputing.com` (Server for Azure Canada hosted organizations)
- `https://api.uk.azure.sigmacomputing.com` (Server for Azure United Kingdom hosted organizations)
- `https://api.au.azure.sigmacomputing.com` (Server for Azure Australia hosted organizations)

## Request

### Path parameters

- `reportId` (string, required)

### Query parameters

- `page` (string, optional)
- `limit` (double, optional)

## Response

### 200

The response body.

- `entries` (list of object, 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` (object, 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` (object, required)
    - `title` (string, required)
    - `messageBody` (string, required)
    - `notificationAttachments` (list of object, required)
      - `formatOptions` (object or object, required)
        - object
          - `type` (enum, required)
            - Allowed values: `PDF`
          - `layout` (enum, optional)
            - Allowed values: `portrait`, `landscape`
          - `scaleFactor` (double, optional)
        - object
          - `type` (enum, required)
            - Allowed values: `NONE`
      - `workbookExportSource` (object, optional)
        - `type` (enum, required)
          - Allowed values: `report`
    - `includeLink` (boolean, optional)
    - `runAsRecipient` (boolean, optional)
    - `attachmentSettings` (object, optional)
      - `mergePdfAttachments` (boolean, optional)
      - `zipAttachments` (boolean, optional)
    - `conditionOptions` (object or object or object or object, optional)
      - object
        - `type` (enum, required)
          - Allowed values: `always`
      - object
        - `type` (enum, required)
          - Allowed values: `workbook`
        - `conditions` (list of object or object or object, required)
          - object
            - `type` (enum, required)
            - `sheetId` (string, required)
          - object
            - `type` (enum, required)
            - `sheetId` (string, required)
          - object
            - `type` (enum, required)
            - `sheetId` (string, required)
            - `mode` (enum or enum, required)
            - `columnId` (string, required)
            - `op` (enum, required)
            - `value` (object or object or object or object or object or object or object or object or object or object, optional)
      - object
        - `type` (enum, required)
          - Allowed values: `worksheet`
        - `conditions` (list of object or object or object, required)
          - object
            - `type` (enum, required)
          - object
            - `type` (enum, required)
          - object
            - `type` (enum, required)
            - `mode` (enum or enum, required)
            - `columnId` (string, required)
            - `op` (enum, required)
            - `value` (object or object or object or object or object or object or object or object or object or object, optional)
      - object
        - `type` (enum, required)
          - Allowed values: `dashboard`
        - `conditions` (list of object or object or object, required)
          - object
            - `type` (enum, required)
            - `tileId` (string, required)
          - object
            - `type` (enum, required)
            - `tileId` (string, required)
          - object
            - `type` (enum, required)
            - `tileId` (string, required)
            - `mode` (enum or enum, required)
            - `columnId` (string, required)
            - `op` (enum, required)
            - `value` (object or object or object or object or object or object or object or object or object or object, optional)
    - `alertConfig` (object, optional)
      - `window` (enum, required)
        - Allowed values: `alltime`, `daily`, `weekly`, `always`
      - `volume` (double, optional, nullable)
    - `notificationName` (string, optional)
    - `reportSettings` (object, optional)
      - `filters` (list of object, optional)
        - `id` (string, required)
        - `filterStr` (string, required)
      - `variableValues` (object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object or object, optional)
        - boolean
          - `type` (enum, required)
            - Allowed values: `boolean`
          - `value` (boolean, required, nullable)
        - number
          - `type` (enum, required)
            - Allowed values: `number`
          - `value` (double, required, nullable)
        - text
          - `type` (enum, required)
            - Allowed values: `text`
          - `value` (string, required, nullable)
        - date
          - `type` (enum, required)
            - Allowed values: `date`
          - `value` (object or object, required, nullable)
            - object
            - object
        - number-list
          - `type` (enum, required)
            - Allowed values: `number-list`
          - `value` (list of double, required)
        - text-list
          - `type` (enum, required)
            - Allowed values: `text-list`
          - `value` (list of string, required)
        - date-list
          - `type` (enum, required)
            - Allowed values: `date-list`
          - `value` (list of double, required)
        - boolean-list
          - `type` (enum, required)
            - Allowed values: `boolean-list`
          - `value` (object, required)
            - `true` (boolean, required)
            - `false` (boolean, required)
            - `null` (boolean, optional)
        - date-range
          - `type` (enum, required)
            - Allowed values: `date-range`
          - `min` (object or object, required, nullable)
            - object
            - object
          - `max` (object or object, required, nullable)
            - object
            - object
        - number-range
          - `type` (enum, required)
            - Allowed values: `number-range`
          - `min` (double, required, nullable)
          - `max` (double, required, nullable)
        - date-null
          - `type` (enum, required)
            - Allowed values: `date-null`
        - number-null
          - `type` (enum, required)
            - Allowed values: `number-null`
        - text-null
          - `type` (enum, required)
            - Allowed values: `text-null`
        - boolean-null
          - `type` (enum, required)
            - Allowed values: `boolean-null`
        - hierarchical-list
          - `type` (enum, required)
            - Allowed values: `hierarchical-list`
          - `value` (list of string, required)
        - file
          - `type` (enum, required)
            - Allowed values: `file`
          - `value` (object, required)
            - `id` (string, required)
            - `name` (string, required)
            - `size` (double, required)
            - `type` (string, required)
            - `downloadUrl` (string, required)
        - file-null
          - `type` (enum, required)
            - Allowed values: `file-null`
        - file-list
          - `type` (enum, required)
            - Allowed values: `file-list`
          - `value` (list of object, required)
            - `id` (string, required)
            - `name` (string, required)
            - `size` (double, required)
            - `type` (string, required)
            - `downloadUrl` (string, required)
    - `dynamicExportSettings` (object, optional)
      - `variables` (map from string to object or object or object or object or object or object or object or object or object or object or object or object or object or object, optional)
        - object
          - `type` (enum, required)
            - Allowed values: `boolean`
        - object
          - `type` (enum, required)
            - Allowed values: `number`
        - object
          - `type` (enum, required)
            - Allowed values: `text`
        - object
          - `type` (enum, required)
            - Allowed values: `date`
        - object
          - `type` (enum, required)
            - Allowed values: `number-list`
        - object
          - `type` (enum, required)
            - Allowed values: `text-list`
        - object
          - `type` (enum, required)
            - Allowed values: `date-list`
        - object
          - `type` (enum, required)
            - Allowed values: `boolean-list`
        - object
          - `type` (enum, required)
            - Allowed values: `date-range`
        - object
          - `type` (enum, required)
            - Allowed values: `number-range`
        - object
          - `type` (enum, required)
            - Allowed values: `date-null`
        - object
          - `type` (enum, required)
            - Allowed values: `number-null`
        - object
          - `type` (enum, required)
            - Allowed values: `text-null`
        - object
          - `type` (enum, required)
            - Allowed values: `boolean-null`
    - `dynamicRecipientSettings` (object, optional)
      - `sourceNodeId` (string, required)
      - `recipientColumnId` (string, required)
    - `rowLimit` (double, optional)
    - `reportVariant` (object, optional)
      - `tagId` (string, optional)
    - `embedOpts` (object, optional)
      - `embedId` (string, optional)
      - `evalConnectionId` (string, optional)
  - `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` (datetime, required, nullable) — Timestamp when the schedule was disabled, or null if the schedule is active.
  - `disabledBy` (string, required, nullable) — 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` (datetime, required) — When the object was created.
  - `updatedAt` (datetime, required) — When the object was last updated.
- `nextPage` (string, required, nullable) — 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` (double, optional) — Total number of results. Useful to determine if there is a need to paginate.
- `hasMore` (boolean, optional) — **[Deprecated]** Indicates whether more results are available.

## Examples

**Response**

```json
{
  "entries": [
    {
      "scheduledNotificationId": "string",
      "reportId": "string",
      "schedule": {
        "cronSpec": "string",
        "timezone": "string"
      },
      "configV2": {
        "title": "string",
        "messageBody": "string",
        "notificationAttachments": [
          {
            "formatOptions": {
              "layout": "portrait",
              "scaleFactor": 1.1,
              "type": "PDF"
            },
            "workbookExportSource": {
              "type": "report"
            }
          }
        ],
        "includeLink": true,
        "runAsRecipient": true,
        "attachmentSettings": {
          "mergePdfAttachments": true,
          "zipAttachments": true
        },
        "conditionOptions": {
          "type": "always"
        },
        "alertConfig": {
          "window": "alltime",
          "volume": 1.1
        },
        "notificationName": "string",
        "reportSettings": {
          "filters": [
            {
              "id": "string",
              "filterStr": "string"
            }
          ],
          "variableValues": {}
        },
        "dynamicExportSettings": {
          "variables": {}
        },
        "dynamicRecipientSettings": {
          "sourceNodeId": "string",
          "recipientColumnId": "string"
        },
        "rowLimit": 1.1,
        "reportVariant": {
          "tagId": "string"
        },
        "embedOpts": {
          "embedId": "string",
          "evalConnectionId": "string"
        }
      },
      "isSuspended": true,
      "ownerId": "string",
      "lastUpdatedByUser": "string",
      "disabledAt": "2024-01-15T09:30:00Z",
      "disabledBy": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "nextPage": "string",
  "total": 1.1,
  "hasMore": true
}
```

**SDK Code**

```python
import requests

url = "https://api.sigmacomputing.com/v2/reports/reportId/schedules"

headers = {"Authorization": "<token>."}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.sigmacomputing.com/v2/reports/reportId/schedules';
const options = {method: 'GET', headers: {Authorization: '<token>.'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sigmacomputing.com/v2/reports/reportId/schedules"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<token>.")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sigmacomputing.com/v2/reports/reportId/schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<token>.'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.sigmacomputing.com/v2/reports/reportId/schedules")
  .header("Authorization", "<token>.")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.sigmacomputing.com/v2/reports/reportId/schedules', [
  'headers' => [
    'Authorization' => '<token>.',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sigmacomputing.com/v2/reports/reportId/schedules");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<token>.");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<token>."]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sigmacomputing.com/v2/reports/reportId/schedules")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```