batch
Returns a single Batch by ID. A Batch groups multiple documents sent together, either as a batch (sequential) or bulk (parallel) send.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
id | ID | No | Global node ID |
batchId | ID | No | Batch-specific ID |
Provide either id or batchId.
Return Type
Example
query GetBatch($id: ID!) {
batch(id: $id) {
id
name
type
status
enforceOrder
progress
documentCount
submittedCount
completedCount
inProgressCount
rejectedCount
awaitingActionCount
bouncedCount
created
modified
creator {
id
name
email
}
documentConnection {
documents {
id
name
status
batchOrder
recipients {
id
email
status
firstName
lastName
}
}
}
}
}