public.workflows.readWorkflows
External DocumentationTo learn more, visit the Ironclad documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Filter | A formula to filter the workflows by. Enclose the workflow attribute ID in brackets and the value in single quotes. You can get the available workflow attributes using the Get Workflow Schema action.For Example: Equals([counterpartyName], 'Harley Quinn')For all the supported formula operations, refer to Ironclad documentation. |
| Last Updated | The date and time to return only the workflows that were updated since it. |
| Page | The number of the page to return results from. The first page is 0. |
| Page Size | The maximum number of results to return per page. Values can range from 1 to 100. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Search | A free-text search across all the workflow properties, matching the in-app search. Maximum is 1000 characters. |
| Status | Select the statuses to return only the workflows that are in them. You can select more than one. If omitted, only active workflows are returned, which include the workflows in the Create, Review, Sign, and Archive stages. |
| Template | Select the template to return only the workflows that were launched from it. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Hydrate Entities | Select to fully hydrate the related entities instead of returning minimal information about them. |
Example Output
{
"page": 0,
"pageSize": 0,
"count": 0,
"list": [
{
"id": "string",
"ironcladId": "string",
"title": "string",
"template": "string",
"step": "string",
"schema": {},
"attributes": {},
"isCancelled": false,
"isComplete": false,
"status": "string",
"creator": {
"id": "string",
"displayName": "string",
"email": "string",
"title": "string",
"username": "string",
"metadata": {}
},
"created": "string",
"lastUpdated": "string",
"roles": [
{
"id": "string",
"displayName": "string",
"assignees": []
}
],
"approvals": {
"state": "string",
"url": "string",
"message": "string"
},
"signatures": {
"state": "string",
"url": "string",
"message": "string"
},
"recordIds": [
"string"
],
"recordType": "string",
"recordTypeDisplayName": "string",
"isRevertibleToReview": false
}
]
}