GET - Get all requests
The EXPORT API allows you to create EXPORT requests and get their status. This page documents the requests
endpoint.
Request structure
Route
The EXPORT API exposes a GET endpoint to get all requests stored:
https://api.batch.com/1.0/BATCH_API_KEY/export/requests
Here is a valid cURL example:
curl -H "Content-Type: application/json" \
-H "X-Authorization: BATCH_REST_API_KEY" \
-X GET "https://api.batch.com/1.0/BATCH_API_KEY/export/requests"
The BATCH_API_KEY
value is either your Live or Dev Batch API key from the settings page of your app within the dashboard (⚙ Settings → General).
Headers
In order to authenticate with the API, you need to provide your company REST API Key as the value of the X-Authorization
header.
Responses
Success
If the GET to the API endpoint is successful you will receive an HTTP 200 confirmation and information about all EXPORT requests.
This information is an array of all requests we currently know of for your application.
Here is an example:
[
{
// response body
},
{
// response body
}
]
Each object in the array contains exactly the same information as you would get if you made a GET request with the request id.
Failure
see failures