List Executions

POST /v2/workflow/executions/list

List Executions

cURL

curl --request POST \
  --url https://api.velt.dev/v2/workflow/executions/list \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "definitionId": "<string>",
    "status": "<string>",
    "pageSize": 123,
    "cursor": "<string>"
  }
}
'

import requests

url = "https://api.velt.dev/v2/workflow/executions/list"

payload = { "data": {
        "definitionId": "<string>",
        "status": "<string>",
        "pageSize": 123,
        "cursor": "<string>"
    } }
headers = {
    "x-velt-api-key": "<x-velt-api-key>",
    "x-velt-auth-token": "<x-velt-auth-token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-velt-api-key': '<x-velt-api-key>',
    'x-velt-auth-token': '<x-velt-auth-token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    data: {
      definitionId: '<string>',
      status: '<string>',
      pageSize: 123,
      cursor: '<string>'
    }
  })
};

fetch('https://api.velt.dev/v2/workflow/executions/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.velt.dev/v2/workflow/executions/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'definitionId' => '<string>',
        'status' => '<string>',
        'pageSize' => 123,
        'cursor' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-velt-api-key: <x-velt-api-key>",
    "x-velt-auth-token: <x-velt-auth-token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.velt.dev/v2/workflow/executions/list"

	payload := strings.NewReader("{\n  \"data\": {\n    \"definitionId\": \"<string>\",\n    \"status\": \"<string>\",\n    \"pageSize\": 123,\n    \"cursor\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-velt-api-key", "<x-velt-api-key>")
	req.Header.Add("x-velt-auth-token", "<x-velt-auth-token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.velt.dev/v2/workflow/executions/list")
  .header("x-velt-api-key", "<x-velt-api-key>")
  .header("x-velt-auth-token", "<x-velt-auth-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"definitionId\": \"<string>\",\n    \"status\": \"<string>\",\n    \"pageSize\": 123,\n    \"cursor\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.velt.dev/v2/workflow/executions/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-velt-api-key"] = '<x-velt-api-key>'
request["x-velt-auth-token"] = '<x-velt-auth-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"definitionId\": \"<string>\",\n    \"status\": \"<string>\",\n    \"pageSize\": 123,\n    \"cursor\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "result": {
    "items": [],
    "nextCursor": "eyJvZmZzZXQiOjEwMH0=",
    "hasMore": true
  }
}

Use this API to paginate through workflow executions. Filter by definitionId and/or status.

Endpoint

POST https://api.velt.dev/v2/workflow/executions/list

Headers

x-velt-api-key · string · required

Your API key.

x-velt-auth-token · string · required

Your Auth Token.

Body

Params

data · object · required

Show properties

definitionId · string

Filter by definition.

status · string

Filter by status. One of: pending / running / completed / failed / cancelled.

pageSize · integer

1–500.

cursor · string

Pass back the previous response’s nextCursor.

List Executions does not accept organizationId or documentId filters in v1. To narrow the result by scope, filter on the returned ExecutionView.steps[].metadata client-side, or paginate with a tighter definitionId filter.

Example Requests

List running executions for a definition

{
  "data": {
    "definitionId": "marketing-copy-approval",
    "status": "running",
    "pageSize": 50
  }
}

Paginate

{
  "data": {
    "pageSize": 50,
    "cursor": "eyJvZmZzZXQiOjEwMH0="
  }
}

Response

Success Response

{
  "result": {
    "items": [ /* ExecutionView[] */ ],
    "nextCursor": "eyJvZmZzZXQiOjEwMH0=",
    "hasMore": true
  }
}

Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}

{
  "result": {
    "items": [],
    "nextCursor": "eyJvZmZzZXQiOjEwMH0=",
    "hasMore": true
  }
}