Sign in
Notifications Runs

Export leaks from a notification run to CSV/TXT/JSON

Queue an export of leaks associated with a specific notification run. Optional search and is_email filters apply. The job runs asynchronously and the file will appear in the Exports section when ready.

Limits

  • You can have at most 5 exports with status PENDING or IN_PROGRESS.

Query parameters

  • format optional output format: csv (default), txt, or json.

Response ExportResponse with status, message, and export_id.

Errors

  • 400 Too many exports in progress.
  • 401 Authentication required, or invalid/expired API key.
  • 404 Run not found.
  • 422 Request validation error.
get/notification_runs/{run_id}/export

Path parameters

run_idinteger required

ID of the notification run.

ID of the notification run.

Query parameters

searchstring nullable

Optional free-text filter on URL or username.

Optional free-text filter on URL or username.

is_emailboolean nullable

Filter by identifier type: true=emails, false=usernames, null=both.

Filter by identifier type: true=emails, false=usernames, null=both.

format'csv' | 'txt' | 'json'

Output format: csv (default), txt, or json.

Response

Export queued successfully.

statusstring required

Export job status: 'queued', 'processing', 'completed', or 'failed'.

messagestring required

Human-readable status message.

export_idinteger required

ID of the export job. Use this to check status or download the result.

Example response

{
  "export_id": 1234,
  "message": "Your export request has been queued. Check the Exports page for progress.",
  "status": "queued"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.