Sign in

v1

latestSwagger 2.02026-07-134026156.7 KB
Submission Batches

Check the status of a submission batch job

Retrieves the status and results of a batch PDF generation job. Returns processing state, completion statistics, and optionally includes all individual submission details. Use this to poll for completion when using asynchronous batch processing.

get/submissions/batches/{submission_batch_id}

Path parameters

submission_batch_idstring required

Query parameters

include_submissionsboolean

Response

processed submission batch found

idstring nullable required
state'pending' | 'processed' | 'error' required
metadataobject required
processed_atstring nullable required
total_countinteger required
pending_countinteger required
error_countinteger required
completion_percentagenumber required