Skip to main content
GET
/
v1
/
export
/
jobs
List Export Jobs
curl --request GET \
  --url https://api.shoal.xyz/v1/export/jobs \
  --header 'Authorization: Bearer <token>'
List export jobs tied to the authenticated Shoal account.

​
Access

  • Access layer: premium
  • Plan floor: enterprise
  • Surface: export

​
Query Parameters

ParameterTypeRequiredDescription
limitintegerNoMax results (default 20, max 20)
offsetintegerNoOffset for the first page (max 100)

​
Request

cURL
curl -X GET "https://api.shoal.xyz/v1/export/jobs?limit=20&offset=0" \
  -H "Authorization: Bearer YOUR_ENTERPRISE_API_KEY"

​
Response (200)

{
  "limit": 20,
  "offset": 0,
  "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

  • Results are scoped to the authenticated account.
  • Export jobs remain separate from feed, replay, and timeline usage.
  • Use GET /v1/export/jobs/:id for a single job record.

​
Errors

  • 403 if the API key does not meet the enterprise plan floor
  • 500 on internal server error