List batches (org-scoped)

curl --request GET \
  --url https://api.runflow.io/v1/batches \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.runflow.io/v1/batches', 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.runflow.io/v1/batches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runflow.io/v1/batches"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.runflow.io/v1/batches")

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

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

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

{
  "items": [
    "<unknown>"
  ],
  "first": "<string>",
  "next": "<string>",
  "previous": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

GET

batches

List batches (org-scoped)

curl --request GET \
  --url https://api.runflow.io/v1/batches \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.runflow.io/v1/batches', 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.runflow.io/v1/batches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runflow.io/v1/batches"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.runflow.io/v1/batches")

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

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

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

{
  "items": [
    "<unknown>"
  ],
  "first": "<string>",
  "next": "<string>",
  "previous": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Organization-Id

string | null

Query Parameters

string | null

sort_by

string | null

limit

integer

default:25

Required range: 1 <= x <= 100

Response

Successful Response

Response envelope for cursor-paginated search results.

Contains the page of items plus first/next/previous pagination links. Concrete entity validators should subclass as::

class SearchValidator(SearchResponse["FullValidator"]):
    pass

to produce a proper OpenAPI schema with typed items.

items

any[]

required

first

string | null

Reference

Additional surfaces

List batches (org-scoped)

Authorizations

Headers

Query Parameters

Response