---
title: "Submit a request to generate a new data export"
method: POST
path: "/exports"
tags: ["Exports"]
---

# Submit a request to generate a new data export

`POST /exports`

Submit a request to generate a new data export. 

**OAuth Scope required:** `public.export.createReports` 

The Data Export feature is part of the paid Security & Data Pro add-on. Contact your Ironclad account representative for more information about purchasing this package.

## Headers

- `x-as-user-email` string
- `x-as-user-id` string

## Request body

- DataExportRequestModel
  - `exportType` 'workflow_activities' | 'audit_log', required — string for record type. Example: `workflow_activities`
  - `startDate` string — Starting date (ISO8601 format) of data to be included in the export. Example: `2016-11-17T00:37:22.318Z`
  - `endDate` string — Starting date (ISO8601 format) of data to be included in the export. Example: `2016-11-17T00:37:22.318Z`
  - `exportFormat` 'CSV' | 'JSON' — File format for the export. CSV is the default.
  - `signedUrlEnabled` boolean — An optional boolean value to enable a signed url for downloading the exported file. If not provided, defaults to false.
  - `exportConfigs` union — Each `exportType` may have additional export configurations specific to this type of export. Use one of the following `exportConfigs` schemas:
    - DataExportConfigWorkflowActivities
      - `metadataProperties` string[] — Array of available custom metadata properties to include in export. Contact support for assistance on locating your custom metadata properties.
      - `includeCommentDetail` boolean — Include comment details in export.
    - DataExportConfigAuditLog
      - `eventCategories` string[] — Array of categories of audit log events to include in the export.

## Response `200`

200

- object
  - `jobId` string
  - `jobStatus` 'pending' | 'running' | 'done' | 'failed'

## Other responses

- `400` — 400

---

[API](https://skmtc.net/ironcladapp/apis/ironclad-public-api.md) · [All operations](https://skmtc.net/ironcladapp/apis/ironclad-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ironcladapp/ironclad-public-api/versions/9459b4cfc1e0/schema)