List Workflow Statuses
Lists workflows invoked and their statuses
| Endpoint URL | Method |
|---|---|
https://apps.inkit.com/api/v1/renders | GET |
Request properties
| Property | Location | Type | Required | Description |
|---|---|---|---|---|
page | query | integer | No | Page number |
page_size | query | integer | No | Number of items per page |
sort | query | string | No | Sort field and direction. Prefix with '-' for descending order. Example: '-created_at', 'name', '-updated_at' |
search | query | string | No | Search term to filter results |
destination_name | query | string | No | Filter by destination name |
destination_status | query | string | No | Filter by destination status |
start_date | query | string | No | Filter by creation date (start) |
end_date | query | string | No | Filter by creation date (end) |
flow_name | query | string | No | Filter by workflow name |
template_id | query | string | No | Filter by template ID |
flow_id | query | string | No | |
flows_batch_id | query | string | No |
Response properties
HTTP 200 — Successful response
| Property | Type | Description |
|---|---|---|
page | integer | Current page number |
page_size | integer | Number of items per page |
total_pages | integer | Total number of pages |
total_items | integer | Total number of items |
items | array |
Example request and response
Use an existing, enabled workflow configured for API/public invocation. It must include Inkit Storage. Configure templates, destinations, and destination input mappings on the workflow before invoking it.
curl --fail-with-body --request POST \
"$INKIT_BASE_URL/api/v1/workflows-invoke" \
--header "X-Inkit-API-Token: $INKIT_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"flow_id": "flow_REPLACEWITHYOURWORKFLOWID",
"merge_parameters": {},
"custom_input_variables": {}
}'flow_id and merge_parameters are required. Optional fields include name, description, custom_data, custom_input_variables, and data_sources. Custom input variable names must exist on the workflow. The server populates destinations from the workflow configuration; do not copy the render request's destinations object into this request.
The 201 response contains the render id and applicable destination identifiers. Poll /api/v1/renders/{id} to follow the invocation. Do not assume every invocation returns a document_id; use the identifiers actually returned and the render details.
The account needs workflow-launch permission and available automation capacity. A disabled workflow, wrong invocation method, invalid variable, or unavailable connector causes an error.
The production /api/v1/workflows-invoke/batch route uses session authentication. It is not an API-key batch endpoint. Older /v1/invoke and /v1/invoke/batch examples are not the request paths in this edition.
Updated 11 days ago