--- title: "List scheduled workbook exports (Paginated)" method: GET path: "/v2.1/workbooks/{workbookId}/schedules" tags: ["Workbooks"] --- # List scheduled workbook exports (Paginated) `GET /v2.1/workbooks/{workbookId}/schedules` ## Request - Base URL: `https://api.sigmacomputing.com` - URL: `https://api.sigmacomputing.com/v2.1/workbooks/{workbookId}/schedules` - Auth: HTTP bearer **Attention:** This API endpoint uses pagination by default. This endpoint retrieves a list of all scheduled exports for a specified workbook. These schedules represent planned events that can trigger exports based on various conditions and timings. ### Usage Notes - The **workbookId** in the path parameter identifies the workbook whose scheduled exports are to be listed. Retrieve the **workbookId** by calling the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) 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 workbook. - **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 workbook has a large number of scheduled exports. - Regularly audit schedules to keep them up-to-date and aligned with the current needs and workflows. ## Path parameters - `workbookId` string, required ## Query parameters - `page` string - `limit` number, double ## Response `200` The response body. - WorkbooksV21ListWorkbookSchedulesResponse200 - `entries` V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItems[], required: Array of results returned by the endpoint - `scheduledNotificationId` string, required: Unique identifier of the scheduled export. - `workbookId` string, required: Unique identifier of the workbook. - `schedule` V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsSchedule, 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` V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2, required - `title` string, required - `messageBody` string, required - `notificationAttachments` V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItems[], required - `formatOptions` union, required - V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions0 - `type` 'CSV', required - V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions1 - `type` 'JSON', required - V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions2 - `type` 'JSONL', required - V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions3 - `type` 'EXCEL', required - V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions4 - `type` 'PDF', required - `layout` 'portrait' | 'landscape' - `scaleFactor` number, double, nullable - V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions5 - `type` 'PNG', required - `pixelWidth` number, double, nullable - `pixelHeight` number, double, nullable - V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsFormatOptions6 - `type` 'NONE', required - `chartId` string - `workbookExportSource` union - V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource0: Export one element - `type` 'element', required - `elementId` string, required - V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource1: Export one page - `type` 'page', required - `pageId` string, required - V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource2: Export multiple elements - `type` 'element', required - `nodeIds` string[], required - V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource3: Export multiple pages - `type` 'page', required - `nodeIds` string[], required - V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2NotificationAttachmentsItemsWorkbookExportSource4: Export all pages and elements in a workbook - `type` 'all', required - `includeLink` boolean - `runAsRecipient` boolean - `attachmentSettings` V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2AttachmentSettings - `mergePdfAttachments` boolean - `zipAttachments` boolean - `conditionOptions` union - V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions0 - `type` 'always', required - V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions1 - `type` 'workbook', required - `conditions` V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf1ConditionsItems[], required - union - … - V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions2 - `type` 'worksheet', required - `conditions` V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf2ConditionsItems[], required - union - … - V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptions3 - `type` 'dashboard', required - `conditions` V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2ConditionOptionsOneOf3ConditionsItems[], required - union - … - `alertConfig` V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2AlertConfig - `window` 'alltime' | 'daily' | 'weekly' | 'always', required - `volume` number, double, nullable - `notificationName` string - `dashboardSettings` V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DashboardSettings - `filters` V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DashboardSettingsFiltersItems[], nullable - `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 - … - `language` 'de' | 'en' | 'es' | 'fr' | 'it' | 'ja' | 'pl' | 'pt' | 'ru' | 'th' | 'en-au' | 'en-ca' | 'en-gb' | 'en-ie' | 'es-mx' | 'fr-ca' | 'ko-kr' | 'nl-nl' | 'pt-br' | 'sv-se' | 'tr-tr' | 'zh-cn' | 'zh-tw': The locale identifier corresponding to the language of the translation. - `languageVariant` string, nullable - `dynamicExportSettings` V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicExportSettings - `variables` object - `dynamicRecipientSettings` V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2DynamicRecipientSettings - `sourceNodeId` string, required - `recipientColumnId` string, required - `rowLimit` number, double - `workbookVariant` V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2WorkbookVariant - `tagId` string - `exploreKey` string - `bookmarkId` string - `embedOpts` V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2EmbedOpts - `embedId` string - `evalConnectionId` string - `formatting` V21WorkbooksWorkbookIdSchedulesGetResponsesContentApplicationJsonSchemaEntriesItemsConfigV2Formatting - `pivotHeaderStyle` 'merged' | 'repeated' - `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)