Skip to main content
GET
/
v1
/
organizations
/
{organization_id}
/
flows
List flows
curl --request GET \
  --url https://api.staging.flxwvdexternal.com/v1/organizations/{organization_id}/flows \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.staging.flxwvdexternal.com/v1/organizations/{organization_id}/flows"

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

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.staging.flxwvdexternal.com/v1/organizations/{organization_id}/flows', 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.staging.flxwvdexternal.com/v1/organizations/{organization_id}/flows",
  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.staging.flxwvdexternal.com/v1/organizations/{organization_id}/flows"

	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://api.staging.flxwvdexternal.com/v1/organizations/{organization_id}/flows")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.staging.flxwvdexternal.com/v1/organizations/{organization_id}/flows")

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
{
  "has_next": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "detection_only": true,
      "cooldown_minutes": 123,
      "enabled": true
    }
  ]
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Accept-Language
enum<string>
default:es-ES

Language code for text fields that support multiple languages. When creating or updating resources, this specifies the language of the provided text values. Upon retrieving resources, it determines which language variant of the multilingual text fields is returned. Accepted values: 'en-EN' (English), 'es-ES' (Spanish), 'pt-BR' (Portuguese), 'ca-ES' (Catalan), 'eu-ES' (Basque). Default is 'es-ES' if not provided.

Available options:
en-EN,
es-ES,
pt-BR,
ca-ES,
eu-ES

Path Parameters

​
organization id
string
required

The unique identifier of the organization

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$

Query Parameters

​
page
integer
default:1

Page number (default: 1)

​
sort
string

Sort field with optional order suffix (:asc or :desc), e.g., "name", "name:asc", "cooldown_minutes:desc". Ascending order is default if no suffix provided. Valid sort fields: id, name, description, type, detection_only, cooldown_minutes, enabled, init_text, ok_text, ko_text.

​
fields
string

Comma-separated list of fields to include in each flow item. Selectable fields: id, name, description, type, detection_only, cooldown_minutes, enabled. The id field is always included.

Maximum string length: 2048
​
filters
string

Filter flows by one or more criteria. Provide a JSON object with filter conditions. You can filter by: id, name, description, type, detection_only, cooldown_minutes, enabled, init_text, ok_text, ko_text. Use comparison operators (eq, ne, gt, gte, lt, lte, in, nin, contains, startsWith, endsWith, between) and combine multiple conditions with logical operators (and, or). Maximum length: 5120 characters.

Maximum string length: 5120
Pattern: ^.*$
​
per_page
integer
default:100

Number of items per page

Required range: 1 <= x <= 100

Response

Paginated list of flows successfully retrieved. The response includes pagination metadata and the flow data array.

​
has_next
boolean
required
​
data
object[]
required