GET - Download export file

The export API allows you to download files extracted by your export request.

API Description

This API schema is available in the OpenAPI 3.1 format: View it online.

Route

The Project Export API exposes a GET endpoint that allows to download result files:

https://api.batch.com/2.3/exports/download

Headers and authentication

See Overview → Using Project APIs.

Query parameters

Id	Description
id	String - Required The export file ID. E.g."/exports/download?id=file_etxhwckcfc05egew7y97bdjtc75p7g8b"

Success

Batch will respond with an HTTP status code: 307. The download link is located under the location section of the response header.

The link to the file will expire after 20 minutes. You will need to call again the API to generate a new file.

Failure

If the POST data does not meet the API requirements you will receive an actionable error message. Contact us at support@batch.com if you need further support.

See the list of potential failures in the specification.