List scheduled workbook exports

Attention: This endpoint will return only paginated responses starting June 2, 2026. To start returning paginated responses before that date, include the query parameter limit in your request.

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 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.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the workbook.

Query Params
string

Use to specify further pages using the string returned in the nextPage portion of the response.

number

Number of results to return per page, with a maximum of 1,000 per request. Use the page option in subsequent requests to retrieve the next set of results.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json