Skip to main content
POST
Export a record set as a file

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

config_id is required unless job_id is set.

config_id
string
space_id
string

Required unless folder is set.

folder
string

Required unless space_id is set.

format
enum<string>
default:csv
Available options:
csv,
json
delivery
enum<string>
default:email
Available options:
email,
download
email
string

Where an emailed export goes. Defaults to the calling user.

filter
string
sort_by
string
zip
boolean
default:false

Wrap the file in a .zip holding it under its usual name.

async
boolean
default:false

Run the export as a job and answer 202 {job_id}. Without it the export runs inline and answers 200.

job_id
string

Sent alone, reads the caller's export job instead of starting one, with or without async. Another user's job is 404.

Response

Success

status_code
integer

HTTP status code echoed in the response body.

body
object

The result of an inline export. A job read instead returns the ExportJob fields: job_id, delivery, status, stage (waiting, reading, writing), read, total, error, result, started_at, updated_at.