Web API

Press shift + S to search API reference.

Compliance

Create eDiscovery export

posthttps://api.airtable.com/v0/meta/enterpriseAccounts/{enterpriseAccountId}/exports

Create an eDiscovery export request. The response includes an id, which is then used to check the status of and download your export.

Requirements

AuthenticationPersonal access token, OAuth integration
Scopeenterprise.exports:manage
User role

Enterprise admin

Billing plansEnterprise Scale

Path parameters

enterpriseAccountId
string

Request body

baseId
string

Base ID to create eDiscovery export for.

includeCsvFormat
optional<boolean>

If set, also export the base as CSVs (in a zipped file). Once the export is ready for download, the URL to the zip file will be available in the csvZipDownloadUrl attribute.

shouldSendEmailOnCompletion
optional<boolean>

If set, an email will be sent to the user who initiated the export once the export is ready for download.

Response format

id
string
data
optional<object>

Available once the export completes.

expirationTime
string

The date and time at which the download URLs expire.

jsonDownloadUrl
string

URL to download JSON export.

csvZipDownloadUrl
optional<string>

URL to download CSV export (as a zipped file), if includeCsvFormat was set for this export.

error
optional<string>

If state is error, this will contain an error message.

state
"pending" | "processing" | "error" | "done"
createdTime
string

A date timestamp in the ISO format, eg:"2018-01-01T00:00:00.000Z"

user
object

The user that created the eDiscovery export.

id
string

A user ID

email
string
name
string
request
object
baseId
string

Base ID of the export.

includeCsvFormat
boolean

Whether the export includes a CSV export (as a zipped file).

shouldSendEmailOnCompletion
boolean

Whether an email notification should be sent when the export is complete.

Error responses

Error Response (404)
Invalid base ID
{
"error": {
"type": "NOT_FOUND"
}
}
Request (example)
Copy
$
curl -X POST "https://api.airtable.com/v0/meta/enterpriseAccounts/{enterpriseAccountId}/exports" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"baseId": "appLkNDICXNqxSDhG"
}'
Request (example)
Copy
$
curl -X POST "https://api.airtable.com/v0/meta/enterpriseAccounts/{enterpriseAccountId}/exports" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"baseId": "appLkNDICXNqxSDhG",
"includeCsvFormat": true,
"shouldSendEmailOnCompletion": true
}'
200 – Response (example)
{
"createdTime": "2021-01-01T00:00:00.000Z",
"id": "etkJkReGfIaW8DZq5",
"request": {
"baseId": "appLkNDICXNqxSDhG",
"includeCsvFormat": true,
"shouldSendEmailOnCompletion": true
},
"state": "processing",
"user": {
"email": "foo@bar.com",
"id": "usrL2PNC5o3H4lBEi",
"name": "Barry Allen"
}
}