List Workflows
Authorization
API Key Authenticate using API Key in request header
In: header
Query Parameters
501 <= value <= 1001 <= items1 <= itemsUsed for search over display names of workflows. Will perform case-insensitive substring matching.
Specifies sorting behavior. The two options are asc and desc to sort ascending and descending respectively, with default sort being ascending. Paging works in both directions.
"asc""asc" | "desc"A cursor to use in pagination. startingAfter is a function ID that defines your place in the list.
A cursor to use in pagination. endingBefore is a function ID that defines your place in the list.
Filter workflows by tags. Workflows must contain all specified tags.
1 <= itemsFilter workflows by function IDs. Returns workflows whose current version uses the current version of the specified functions.
1 <= itemsFilter workflows by function names. Returns workflows whose current version uses the current version of the specified functions.
1 <= itemsFilter workflows by specific function versions using function IDs. Format: functionID.versionNum (e.g., "f_abc123.2"). Returns workflows whose current version uses the specified function versions.
1 <= itemsFilter workflows by specific function versions using function names. Format: functionName.versionNum (e.g., "invoice-processing.2"). Returns workflows whose current version uses the specified function versions. Resolves to functions that currently have the specified names.
1 <= itemsResponse Body
application/json
curl -X GET "https://api.bem.ai/v2/workflows?tags=billing%2Cfinance&functionIDs=f_123%2Cf_456&functionNames=transform-invoice%2Cextract-data&functionIDVersionNums=f_123.2%2Cf_456.1&functionNameVersionNums=transform-invoice.2%2Cextract-data.1"{
"workflows": [
{
"id": "string",
"name": "string",
"versionNum": 0,
"displayName": "string",
"emailAddress": "string",
"tags": [
"billing",
"finance",
"automated"
],
"mainFunction": {
"id": "string",
"name": "string",
"versionNum": 0
},
"relationships": [
{
"sourceFunction": {
"id": "string",
"name": "string",
"versionNum": 0
},
"destinationName": "string",
"destinationFunction": {
"id": "string",
"name": "string",
"versionNum": 0
}
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"audit": {
"workflowCreatedBy": {
"userActionID": "string",
"userID": "string",
"userEmail": "string",
"apiKeyName": "string",
"emailAddress": "string",
"createdAt": "2019-08-24T14:15:22Z"
},
"workflowLastUpdatedBy": {
"userActionID": "string",
"userID": "string",
"userEmail": "string",
"apiKeyName": "string",
"emailAddress": "string",
"createdAt": "2019-08-24T14:15:22Z"
},
"versionCreatedBy": {
"userActionID": "string",
"userID": "string",
"userEmail": "string",
"apiKeyName": "string",
"emailAddress": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
}
}
],
"totalCount": 0,
"error": "string"
}