List Flow Batches

Endpoint URL	SDK Method
`https://api.inkit.com/v1/invoke/batch` (GET)	N/A

Request properties

Property	Type	Required	Description
`page`	Integer	No	The page of the list you want to pull. The default is `1`.
`page_size`	Integer	No	The number of records to pull per page. The default is `25`.
`sort`	String	No	The sort key. If the key is preceded with a `-`, the request will sort the records in descending order. Otherwise it will sort in ascending order.
`search`	String	No	The search key. The request will only return records with this key.
`destination_name`	String	No	The request will only return records with this destination name.
`destination_status`	String	No	The request will only return records with this destination status.

Response properties

Property	Type	Description
`items`	Object[]	An array of batches launched.
`metadata`	Object	Metadata relating to the list.

`items`

Property	Type	Description
`created_at`	String	The date and time the batch was created.
`destinations`	Object	The status of generations within the batch.
`id`	String	The ID of the batch.
`name`	String	The name of the batch.
`status`	String	The status of the batch.
`total`	Integer	The number of the 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 \
     --header 'X-Inkit-API-Token: ENTER YOUR API KEY' \
     --header 'accept: application/json'

{
    "items": [
        {
            "created_at": "2023-11-07T03:05:52.298042Z",
            "destinations": {
                "inkit_storage": {
                    "completed": 1,
                    "count": 1,
                    "failed": 0,
                    "in_progress": 0,
                    "status": "completed"
                }
            },
            "id": "fb_5s6Sy8bUjdRscqwSJ2hmCc",
            "name": "Batch Name",
            "status": "In Progress",
            "total": 1
        },
        {
            "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
        }
    ],
    "metadata": {
        "pagination": {
            "current_page": 1,
            "next_page": null,
            "page_count": 1,
            "page_size": 25,
            "prev_page": null,
            "total_count": 2
        },
        "sort": {
            "key": "created_at",
            "order": 1
        }
    }
}