JustFlows docs

API reference

List workflow runs

GET /api/v1/runs

cURL

curl --request GET \
  --url '/api/v1/runs' \
  --header 'Authorization: Bearer <token>'

JavaScript

const response = await fetch('/api/v1/runs', {
  method: 'GET',
  headers: {
    "Authorization": "Bearer <token>"
  }
});

const data = await response.json();

Python

import requests

response = requests.request(
    "GET",
    "/api/v1/runs",
    headers={
      "Authorization": "Bearer <token>"
    },
)

print(response.json())

PHP

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', '/api/v1/runs', [
    'headers' => [
        'Authorization' => 'Bearer <token>',
    ],
]);

echo $response->getBody();

Go

package main

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

func main() {
	req, _ := http.NewRequest("GET", "/api/v1/runs", nil)
	req.Header.Add("Authorization", "Bearer <token>")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

Ruby

require "net/http"

uri = URI("/api/v1/runs")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

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

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("/api/v1/runs"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Authorization

A bearer token in the Authorization header.

Query parameters

NameTypeRequiredDescription
cursorstringNoOpaque cursor returned by the preceding list response.
per_pageintegerNoNumber of records to return.
Default: 25
statusstringNoOne of: pending, running, waiting, finished, failed, canceled
workflow_idstringNo

Responses

200 · Runs in the token workspace.
NameTypeRequiredDescription
dataarray of RunYes
data[].idstringYes
data[].objectstringYes
data[].workflow_idstring or nullYes
data[].statusstringYesOne of: pending, running, waiting, finished, failed, canceled
data[].current_node_keystring or nullNo
data[].outputanyYesRedacted workflow output.
data[].errornullYes
data[].execution_msinteger or nullNo
data[].started_atstring (date-time) or null (date-time)No
data[].finished_atstring (date-time) or null (date-time)No
data[].created_atstring (date-time) or null (date-time)Yes
data[].updated_atstring (date-time) or null (date-time)Yes
metaCursorMetaYes
meta.next_cursorstring or nullYes
meta.previous_cursorstring or nullYes
meta.has_morebooleanYes
request_idstringYes
{
  "data": [
    {
      "id": "string",
      "object": "run",
      "workflow_id": "string",
      "status": "pending",
      "current_node_key": "string",
      "output": null,
      "error": null,
      "execution_ms": 0,
      "started_at": "2024-01-01T00:00:00Z",
      "finished_at": "2024-01-01T00:00:00Z",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "previous_cursor": "string",
    "has_more": true
  },
  "request_id": "string"
}
401 · The Bearer token is missing, malformed, expired, or revoked.
NameTypeRequiredDescription
errorobjectYes
error.codestringYes
error.messagestringYes
error.detailsobjectNo
request_idstringYes
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "request_id": "string"
}
403 · The token lacks the required ability.
NameTypeRequiredDescription
errorobjectYes
error.codestringYes
error.messagestringYes
error.detailsobjectNo
request_idstringYes
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "request_id": "string"
}
422 · The request is invalid or the workspace cannot perform the operation.
NameTypeRequiredDescription
errorobjectYes
error.codestringYes
error.messagestringYes
error.detailsobjectNo
request_idstringYes
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "request_id": "string"
}
429 · A per-token rate limit was exceeded.
NameTypeRequiredDescription
errorobjectYes
error.codestringYes
error.messagestringYes
error.detailsobjectNo
request_idstringYes
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "request_id": "string"
}
503 · The site administrator has disabled the Workspace API.
NameTypeRequiredDescription
errorobjectYes
error.codestringYes
error.messagestringYes
error.detailsobjectNo
request_idstringYes
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "request_id": "string"
}