Workflows
List Workflows
x-api-key<token>
Authenticate using API Key in request header
In: header
Query Parameters
limit?integer
Default
50Range
1 <= value <= 100workflowIDs?array<string>
Items
1 <= itemsworkflowNames?array<string>
Items
1 <= itemsdisplayName?string
Used for search over display names of workflows. Will perform case-insensitive substring matching.
sortOrder?string
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.
Default
"asc"Value in
"asc" | "desc"startingAfter?string
A cursor to use in pagination. startingAfter is a function ID that defines your place in the list.
endingBefore?string
A cursor to use in pagination. endingBefore is a function ID that defines your place in the list.
tags?array<string>
Filter workflows by tags. Workflows must contain all specified tags.
Items
1 <= itemsResponse Body
curl -X GET "https://api.bem.ai/v2/workflows?limit=50&workflowIDs=string&workflowNames=string&displayName=string&sortOrder=asc&startingAfter=string&endingBefore=string&tags=billing%2Cfinance"{
"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"
}
],
"totalCount": 0,
"error": "string"
}