List Flow Statuses

Endpoint URL	SDK Method
`https://api.inkit.com/v1/invoke` (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.
`data_id`	String	No	A comma-delimited list of Render IDs to return.
`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 documents and folders generated.
`metadata`	Object	Metadata relating to the list.

`items`

Property	Type	Description
`created_at`	String	The date and time the flow was invoked.
`description`	String	The description of the flow.
`destination_status`	String	The destination status of the flow.
`destinations`	Object	Flow destination data.
`flow_id`	String	The ID of the flow.
`flow_name`	String	The name of the flow.
`flows_batch_id`	String	The batch ID associated with the flow.
`id`	String	The invocation ID of the flow.
`merge_parameters`	Object	The key-value pairs you used when invoking your flow.
`name`	String	The execution name of the flow.
`status`	String	The status of the flow.

`destinations`

Property	Type	Description
`amazon_s3`	Object	Amazon S3 destination data if the flow contains an Amazon S3 destination.
`box`	Object	Box destination data if the flow contains a Box destination.
`docusign`	Object	DocuSign destination data if the flow contains a DocuSign destination.
`dropbox`	Object	Dropbox destination data if the flow contains a Dropbox destination.
`google_drive`	Object	Google Drive destination data if the flow contains a Google Drive.
`inkit_storage`	Object	Inkit Storage destination data.
`magic_link`	Object	Magic Link destination data if the flow contains a Magic Link destination.
`salesforce`	Object	Salesforce destination data if the flow contains a Sepire destination.
`sepire`	Object	Sepire destination data if the flow contains a Salesforce destination.

`amazon_s3`

Property	Type	Description
`amazon_s3_piece_id`	String	The Amazon S3 document ID.
`status`	String	The status of the document generated.

`box`

Property	Type	Description
`box_piece_id`	String	The Box document ID.
`status`	String	The status of the document generated.

`docusign`

Property	Type	Description
`docusign_piece_id`	String	The DocuSign document ID.
`status`	String	The status of the document generated.

`dropbox`

Property	Type	Description
`dropbox_piece_id`	String	The Dropbox document ID.
`status`	String	The status of the document generated.

`google_drive`

Property	Type	Description
`google_drive_piece_id`	String	The Google Drive document ID.
`status`	String	The status of the document generated.

`inkit_storage`

Property	Type	Description
`document_id`	String	The Inkit Storage document ID.
`name`	String	The Inkit Storage document name.
`status`	String	The status of the document generated.

`magic_link`

Property	Type	Description
`magic_link_piece_id`	String	The Magic Link document ID.
`status`	String	The status of the document generated.

`salesforce`

Property	Type	Description
`salesforce_piece_id`	String	The Salesforce document ID.
`status`	String	The status of the document generated.

`sepire`

Property	Type	Description
`mail_piece_id`	String	The Sepire document ID.
`status`	String	The status of the document generated.

Example request and response

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

{
   "items":[
      {
         "created_at":"2023-11-07T02:31:22.232287Z",
         "description":null,
         "destination_status":"Completed",
         "destinations":{
            "inkit_storage":{
               "document_id":"doc_NB1RnyuzZkN6HAJ4xVWOO",
               "name":"Hi.pdf",
               "status":"Completed"
            }
         },
         "flow_created_at":"2023-10-25T16:13:39.170009Z",
         "flow_id":"flow_1HsyLDikoFkeLg0ZkgIq57",
         "flow_name":"Hi",
         "flows_batch_id":null,
         "id":"rend_2DhtpDQ5ErIaNJQRtCpKfN",
         "merge_parameters":{
            "lname":"Mayer",
            "name":"Andrew"
         },
         "name":null,
         "status":"Completed",
         "template_id":null,
         "template_version":null
      },
      {
         "created_at":"2023-07-24T21:22:42.264095Z",
         "description":null,
         "destination_status":"Failed",
         "destinations":{
            "inkit_storage":{
               "document_id":"doc_2jFOVLmh0e5PYmDeENACgN",
               "name":"demo",
               "status":"Completed"
            },
            "sepire":{
               "mail_piece_id":"mp_3rD7NiYDewMnxp8YVstIh0",
               "status":"Failed"
            }
         },
         "flow_created_at":null,
         "flow_id":null,
         "flow_name":null,
         "flows_batch_id":null,
         "id":"rend_rHbYbzClfysX85KrJeKCB",
         "merge_parameters":{
            
         },
         "name":null,
         "status":"Completed",
         "template_id":"tmpl_1oR7iN7IBiEkOP39aHWfPm",
         "template_version":2
      }
   ],
   "metadata":{
      "pagination":{
         "current_page":1,
         "next_page":2,
         "page_count":108,
         "page_size":25,
         "prev_page":108,
         "total_count":2693
      },
      "sort":{
         "key":"updated_at",
         "order":1
      }
   }
}