# Get Scheduled Exports

GET /v3/exports/scheduled

Endpoint: GET /v3/exports/scheduled
Security: API_Key

## Query parameters:

  - `search` (string)
    Return Scheduled Exports which contain the provided text in their name, 
schedule description, owner user name, or exported item name.

  - `exportedItemType` (string)
    Return Scheduled Exports with specified exported item type.
    Enum: "saved_report"

  - `exportedItemId` (integer)
    Return Scheduled Exports for a specific exported item.
Should be used together with  parameter.

  - `size` (integer)

  - `sortBy` (string)
    Enum: "name", "schedule_description", "schedule_is_paused", "owner_user_name", "exported_item_type", "exported_item_name", "is_editable", "created_at", "updated_at"

  - `page` (integer)
    Number of results page of an endpoint with paginated results

  - `sortDesc` (boolean)
    Controls sorting order

## Response 200 fields (application/json):

  - `metadata` (object)
    Common metadata for iterable

  - `metadata.pagination` (object, required)

  - `metadata.pagination.totalCount` (integer, required)
    Total number of items available from all result pages combined

  - `metadata.pagination.totalPageCount` (integer, required)
    Total number of pages available

  - `metadata.pagination.pageSize` (integer, required)
    Page size - number of items per result page configured by  query parameter or default page size

  - `metadata.pagination.currentPageSize` (integer, required)
    Number of items in current result page

  - `metadata.pagination.currentPageNumber` (integer, required)
    Current page number/ordinal

  - `scheduledExports` (array)

  - `scheduledExports.name` (string, required)

  - `scheduledExports.exportedItemType` (string, required)
    Enum: "saved_report"

  - `scheduledExports.exportedItemId` (integer, required)

  - `scheduledExports.exportFileFormat` (string, required)
    Enum: "csv", "tsv", "xlsx", "parquet"

  - `scheduledExports.exportEmailConfig` (object, required)
    Configuration for the email sent when export completes.

  - `scheduledExports.exportEmailConfig.addExportFileAttachment` (boolean, required)

  - `scheduledExports.exportEmailConfig.customMessage` (string)

  - `scheduledExports.exportEmailConfig.reportLinkType` (string)
    Enum: "public_link", "regular_link"

  - `scheduledExports.emails` (array, required)
    List of email addresses that will receive export email.
    Example: ["user@example.com"]

  - `scheduledExports.id` (integer, required)

  - `scheduledExports.createdAt` (string)
    Date-time in [RFC3339 profile ISO 8601 format](https://www.ietf.org/rfc/rfc3339.txt) with
the following additional restrictions:
1. An uppercase T must separate the date and time portions.
2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in
[AWS Step Functions - Choice Rules](https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-choice-state.html)
    Example: "2016-08-18T17:33:00Z"

  - `scheduledExports.updatedAt` (string)
    Date-time in [RFC3339 profile ISO 8601 format](https://www.ietf.org/rfc/rfc3339.txt) with
the following additional restrictions:
1. An uppercase T must separate the date and time portions.
2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in
[AWS Step Functions - Choice Rules](https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-choice-state.html)
    Example: "2016-08-18T17:33:00Z"

  - `scheduledExports.owner` (object)

  - `scheduledExports.owner.id` (integer, required)
    ID of a user
    Example: 123

  - `scheduledExports.owner.userName` (string, required)

  - `scheduledExports.schedule` (object, required)
    When and how often Scheduled Export will be run.

  - `scheduledExports.schedule.dtStart` (string, required)
    Date of first desired start (if in range of recurrence rule).
    Example: "2025-03-14T12:00:00"

  - `scheduledExports.schedule.recurrenceRule` (string, required)
    An RFC-5545 (https://www.rfc-editor.org/rfc/rfc5545#appendix-A) compliant recurrence rule string.
    Example: "WKST=SU;FREQ=DAILY;INTERVAL=1"

  - `scheduledExports.schedule.tzId` (string, required)
    Timezone identifier compliant with tz database (ex. America/New_York). https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
    Example: "America/New_York"

  - `scheduledExports.schedule.isPaused` (boolean, required)
    Whether the schedule is paused or not.

  - `scheduledExports.schedule.exceptions` (array)
    List of dates to skip when scheduling.
    Example: ["2025-03-14T12:00:00"]

  - `scheduledExports.schedule.description` (string, required)
    Example: "Every day"

  - `scheduledExports.schedule.presetType` (string, required)
    Example: "DAILY"

  - `scheduledExports.schedule.nextExportAt` (string)
    Date-time in [RFC3339 profile ISO 8601 format](https://www.ietf.org/rfc/rfc3339.txt) with
the following additional restrictions:
1. An uppercase T must separate the date and time portions.
2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in
[AWS Step Functions - Choice Rules](https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-choice-state.html)
    Example: "2016-08-18T17:33:00Z"

  - `scheduledExports.exportedItemName` (string, required)

  - `scheduledExports.isEditable` (boolean, required)

## Response 400 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)

## Response 401 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)

## Response 403 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)