List flows

List flows for an organization.

GET /flows/{org}

List flows

cURL

curl --request GET \
  --url https://app.kosli.com/api/v2/flows/{org} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.kosli.com/api/v2/flows/{org}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://app.kosli.com/api/v2/flows/{org}', 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://app.kosli.com/api/v2/flows/{org}",
  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://app.kosli.com/api/v2/flows/{org}"

	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))

}

HttpResponse<String> response = Unirest.get("https://app.kosli.com/api/v2/flows/{org}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kosli.com/api/v2/flows/{org}")

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

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "org": "<string>",
      "template": "<unknown>",
      "repo_url": "<string>",
      "tags": null
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "per_page": 123,
    "page_count": 123
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

org · string · required

Query Parameters

search_by_name · string | null

Return flows that contain the given string in their name. Only alphanumeric characters and '-' are allowed.

case_sensitive · boolean · default: true

Whether the search_by_name filter is case sensitive. Defaults to true.

page · integer | null · default: 1

The page number of response

Required range: x >= 1

per_page · integer | null

How many results to return per page. When omitted, all flows are returned as a plain list (no pagination envelope).

Required range: 1 <= x <= 100

Response

200 - application/json

Successful Response

ListFlows · object

FlowList · object[]

Response model for listing flows with pagination.

When pagination is not requested, the endpoint returns a list of flows directly (backwards compatible with the CLI). When pagination is requested, it returns data with optional pagination info.

data · FlowList · object[] · required

List of flows

Show child attributes

pagination · ListFlowsPagination · object | null

Pagination info (only present when there are multiple pages)

Show child attributes