curl --request GET \
--url https://{subdomain}.conveyour.com/api/exports/public/{pid}/downloadconst options = {method: 'GET'};
fetch('https://{subdomain}.conveyour.com/api/exports/public/{pid}/download', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {method: 'GET'};
fetch('https://{subdomain}.conveyour.com/api/exports/public/{pid}/download', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/exports/public/{pid}/download"
response = requests.get(url)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/exports/public/{pid}/download",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}{
"status": "failed",
"message": "Contact not found",
"data": []
}Download an export by public ID
Public download by pid. No authentication required. Generates a pre-signed URL for a ready export and redirects (302) to it.
None | Redirect to a pre-signed download URL by public pid
This endpoint requires no authentication. Anyone who has the export pid can download the full export file — treat the pid as a secret.
curl --request GET \
--url https://{subdomain}.conveyour.com/api/exports/public/{pid}/downloadconst options = {method: 'GET'};
fetch('https://{subdomain}.conveyour.com/api/exports/public/{pid}/download', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {method: 'GET'};
fetch('https://{subdomain}.conveyour.com/api/exports/public/{pid}/download', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/exports/public/{pid}/download"
response = requests.get(url)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/exports/public/{pid}/download",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}{
"status": "failed",
"message": "Contact not found",
"data": []
}Path Parameters
The export's public pid.
Query Parameters
Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.
Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.
Response
Redirect to a pre-signed download URL. There is no JSON body on success. Follow the Location header to fetch the bundle.
The Location URL is a pre-signed S3 (DigitalOcean Spaces) link valid for 1 hour. It serves the stored bundle with Content-Disposition: attachment and a filename derived from the export's name; the extension comes from the stored bundle_path (falling back to .bin). Follow the redirect with a plain GET — do not send the x-conveyour-token header to the S3 host.