Data Export API
The API provides endpoints to initiate an export, download export files and rerun a previously run export. Your application will be notified with status updates via webhook to the Calling URL as the export job status changes.
To use the API you must create an application for the export, you will be given a secret token to use in your requests. For details on how to integrate with the data export API see the Developer Guide.
warning
It is not possible to delete an application, if an application is no longer needed disable the application.
Creating a new scheduled export
- Navigate to the Data Export management area and open the export record.
- Click the API tab and then click the New Application button.
- Complete the application details, enable the application and click the Save button to save your changes.
- You'll now be shown the unique token to use in your requests when using this application. Make a note of the access token as it is only shown once. Use the Copy button to copy the token to your clipboard. Click the Finish button.
API application fields
| Field | Notes | Required? |
|---|---|---|
| Name | A descriptive name to help you identify the application at a later date. | ✅ |
| Callback URL | The URL used to notify your application when the export status changes. The URL must use https protocol. | ✅ |
| Enabled | The status of the application. |