Retrieve Flow Batch Information

Endpoint URL	SDK Method
`https://api.inkit.com/v1/invoke/batch/{batchId}`	N/A

Request properties

Property	Type	Required	Description
`batchId`	String	Yes	The ID of a batch that was previously launched.

Response properties

Property	Type	Description
`created_at`	String	The date and time the batch was created.
`destinations`	Object	The status of document generations within the batch.
`id`	String	The ID of the batch.
`name`	String	The name of the batch.
`status`	String	The batch creation status.
`total`	Integer	The number of documents in the batch.

`destinations`

Property	Type	Description
`inkit_storage`	Object	The status of Inkit Storage document generations within the batch.
`salesforce`	Object	The status of Salesforce document generations within the batch.
`sepire`	Object	The status of Sepire document generations within the batch.
`docusign`	Object	The status of DocuSign document generations within the batch.
`magic_link`	Object	The status of Magic Link document generations within the batch.
`amazon_s3`	Object	The status of Amazon S3 document generations within the batch.
`google_drive`	Object	The status of Google Drive document generations within the batch.
`dropbox`	Object	The status of Dropbox document generations within the batch.
`box`	Object	The status of Box document generations within the batch.

`[destination]`

Property	Type	Description
`count`	Integer	The total number of document generations within the batch for this destination.
`completed`	Integer	The total number of completed document generations within the batch for this destination.
`failed`	Integer	The total number of failed document generations within the batch for this destination.
`in_progress`	Integer	The total number of in-progress document generations within the batch for this destination.

Example request and response

curl --request GET \
     --url https://api.inkit.com/v1/invoke/batch/fb_4AO6oyjh5yc9jvRKJplghb \
     --header 'X-Inkit-API-Token: ENTER YOUR API KEY' \
     --header 'accept: application/json'

{
	"created_at": "2023-11-07T02:16:22.319388Z",
	"destinations": {
		"inkit_storage": {
			"completed": 1,
			"count": 1,
			"failed": 0,
			"in_progress": 0,
			"status": "completed"
		}
	},
	"id": "fb_4AO6oyjh5yc9jvRKJplghb",
	"name": "Batch Name",
	"status": "Completed",
	"total": 1
}