Get Export Job
curl --request GET \
--url https://api.shoal.xyz/v1/export/jobs/:id \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.shoal.xyz/v1/export/jobs/:id"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.shoal.xyz/v1/export/jobs/:id', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.shoal.xyz/v1/export/jobs/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoal.xyz/v1/export/jobs/:id"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.shoal.xyz/v1/export/jobs/:id")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoal.xyz/v1/export/jobs/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyExport
Get Export Job
Retrieve one export job by id
GET
/
v1
/
export
/
jobs
/
:id
Get Export Job
curl --request GET \
--url https://api.shoal.xyz/v1/export/jobs/:id \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.shoal.xyz/v1/export/jobs/:id"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.shoal.xyz/v1/export/jobs/:id', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.shoal.xyz/v1/export/jobs/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoal.xyz/v1/export/jobs/:id"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.shoal.xyz/v1/export/jobs/:id")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoal.xyz/v1/export/jobs/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyUse this route to inspect the current status and fulfillment metadata for a specific export request.
Access
- Access layer:
premium - Plan floor:
enterprise - Surface:
export
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Export job id |
Request
cURL
curl -X GET "https://api.shoal.xyz/v1/export/jobs/d9d2a2e6-2df2-45ef-9f08-2e1ab36ef8e0" \
-H "Authorization: Bearer YOUR_ENTERPRISE_API_KEY"
Response (200)
{
"data": {
"id": "d9d2a2e6-2df2-45ef-9f08-2e1ab36ef8e0",
"appUserId": "app_user_123",
"apiKeyId": 17,
"scope": "replay.global",
"format": "jsonl",
"status": "requested",
"requestedParams": {
"since": "2026-04-01T00:00:00.000Z",
"until": "2026-04-10T00:00:00.000Z",
"category": null,
"includeEvidence": true,
"organizationIds": []
},
"note": "Internal warehouse backfill for April incident review",
"downloadUrl": null,
"expiresAt": null,
"error": null,
"createdAt": "2026-04-11T20:15:00.000Z",
"updatedAt": "2026-04-11T20:15:00.000Z"
}
}
Notes
- Export jobs are account-scoped.
downloadUrlandexpiresAtremainnulluntil fulfillment is complete.- This route is the right place to poll status instead of replaying bulk data routes.
Errors
- 404 if the export job does not exist for the authenticated account
- 403 if the API key does not meet the enterprise plan floor
- 500 on internal server error
⌘I