Submit a request to generate a new data export

post

https://ironcladapp.com/public/api/v1/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

exportType

string

enum

required

string for record type. Example: workflow_activities

Allowed:

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

string

enum

File format for the export. CSV is the default.

Allowed:

signedUrlEnabled

boolean

An optional boolean value to enable a signed url for downloading the exported file. If not provided, defaults to false.

exportConfigs

Each exportType may have additional export configurations specific to this type of export. Use one of the following exportConfigs schemas:

Headers

x-as-user-email

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

x-as-user-id

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400