Skip to main content
POST
/
workflows
/
runs
Filter workflow runs
curl --request POST \
  --url https://core.ravenna.ai/api/workflows/runs \
  --header 'Content-Type: application/json' \
  --header 'x-ravenna-api-token: <api-key>' \
  --data '{
  "skip": 2,
  "offset": 1,
  "cursor": "<string>",
  "limit": 5000.5,
  "set": "<string>",
  "sortBy": "<string>",
  "sortDirection": "asc",
  "groupBy": "<string>",
  "groupDirection": "asc",
  "workspaceId": "<string>",
  "workflowIds": [
    "<string>"
  ],
  "collectionIds": [
    "<string>"
  ],
  "workflowDetails": true,
  "collectionDetails": true,
  "statuses": [
    "pending"
  ],
  "dateRange": {
    "from": "<string>",
    "to": "<string>"
  },
  "since": "<string>"
}'
{
  "items": [
    {
      "id": "<string>",
      "status": "pending",
      "workflowId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "workflow": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "collection": {
          "id": "<string>",
          "name": "<string>",
          "icon": "<string>",
          "color": "<string>"
        }
      }
    }
  ],
  "totalCount": 123,
  "nextCursor": "<string>"
}

Authorizations

​
x-ravenna-api-token
string
header
required

Body

application/json
​
skip
number | null
Required range: x >= 1
​
offset
number | null
Required range: x >= 0
​
cursor
string | null
​
limit
number | null
default:100
Required range: 1 <= x <= 10000
​
set
string | null
​
sortBy
string | null
​
sortDirection
enum<string> | null
Available options:
asc,
desc
​
groupBy
string | null
​
groupDirection
enum<string> | null
Available options:
asc,
desc
​
workspaceId
string | null
​
workflowIds
string[]
​
collectionIds
string[]
​
workflowDetails
boolean
​
collectionDetails
boolean
​
statuses
enum<string>[]
​
dateRange
object
​
since
string

Response

Successful response

​
items
object[]
required
​
totalCount
number
required
​
nextCursor
string | null
⌘I