Getting Started with Data Exports

📌
Data Export Pricing
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.
See an overview of the Security & Data Pro Add-on in our Help Center

How to use Data Exports

Request Flow

Client submits an API request via Public API with request body payload to trigger an export job
- Client receives a job id
Client submits an API request to check on the job status
- Client receives the job status
If the job is complete, client retrieves the file with the /exports/job/{jobId}/download endpoint

Example curl calls

Trigger an Export Job

📘
API Examples
This section features examples of some of the exports and configurations available. Please consult the API Reference for a full list of options.

Standard Workflow Activities Export: Standard Fields & All Activities

curl --request POST \
     --url 'https://na1.ironcladapp.com/public/api/v1/exports' \
     --header "Authorization: $BEARER_AUTH_TOKEN" \
     --header 'Content-Type: application/json' \
     --data '
     {
        "exportType": "workflow_activities"
     }'

Customized Workflow Activities Export: Time Range

curl --request POST \
    --url 'https://na1.ironcladapp.com/public/api/v1/exports' \
    --header "Authorization: $BEARER_AUTH_TOKEN" \
    --header 'Content-Type: application/json' \
    --data '
    {
    "exportType": "workflow_activities",
    "startDate": "2023-07-01",
    "endDate": "2023-07-13"
    }'

Customized Workflow Activities Export type: Audit log

curl --request POST \
    --url 'https://na1.ironcladapp.com/public/api/v1/exports' \
    --header "Authorization: $BEARER_AUTH_TOKEN" \
    --header 'Content-Type: application/json' \
    --data '
    {
    "exportType": "audit_log"
    }'

Customized Workflow Activities Export: Include approver comment details

curl --request POST \
    --url 'https://na1.ironcladapp.com/public/api/v1/exports' \
    --header "Authorization: $BEARER_AUTH_TOKEN" \
    --header 'Content-Type: application/json' \
    --data '
    {
    "exportType": "workflow_activities",
    "exportConfig": {
        "includeCommentDetail": true
    }
    }'

Customized Workflow Activities Export: Include clause exception request information

curl --request POST \
    --url 'https://na1.ironcladapp.com/public/api/v1/exports' \
    --header "Authorization: $BEARER_AUTH_TOKEN" \
    --header 'Content-Type: application/json' \
    --data '
    {
    "exportType": "workflow_activities",
    "exportConfig": {
        "includeExceptionRequestInfo": true
    }
    }'

Customized Workflow Activities Export: Include metadata properties

curl --request POST \
    --url 'https://na1.ironcladapp.com/public/api/v1/exports' \
    --header "Authorization: $BEARER_AUTH_TOKEN" \
    --header 'Content-Type: application/json' \
    --data '
    {
    "exportType": "workflow_activities",
    "exportConfig": {
        "workflowAttributes": ["consultantServicesDescription", "counterpartyName", "iProcTotalAmount"]
    } 
    }

Retrieve the status of an Export Job

curl --request GET \
     --header "Authorization: $BEARER_AUTH_TOKEN" \
     --url 'https://na1.ironcladapp.com/public/api/v1/exports/$JOB_ID'

Retrieve the export results

curl --request GET \
     --header "Authorization: $BEARER_AUTH_TOKEN" \
     --url 'https://na1.ironcladapp.com/public/api/v1/exports/$JOB_ID/download'

📌
Note:
Exports can only be retrieved within 14 days of creation. Past this point, a new export is required.