Listar fluxos

GET

organizations

{organization_id}

flows

Listar fluxos

curl --request GET \
  --url https://api.flexxible.net/v2/organizations/{organization_id}/flows \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.flexxible.net/v2/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.flexxible.net/v2/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.flexxible.net/v2/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.flexxible.net/v2/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.flexxible.net/v2/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>",
      "type": "session",
      "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>"
  }
}

Autorizações

Authorization

string

header

obrigatório

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

Cabeçalhos

Accept-Language

enum<string>

padrão:es-ES

Código de idioma para campos de texto que suportam múltiplos idiomas. Ao criar ou atualizar recursos, isso especifica o idioma dos valores de texto fornecidos. Ao recuperar recursos, isso determina qual variante de idioma dos campos de texto multilíngues é devolvida. Valores aceitos: 'en-EN' (inglês), 'es-ES' (espanhol), 'pt-BR' (português), 'ca-ES' (catalão), 'eu-ES' (euskera). Usa 'es-ES' por padrão se não fornecido.

Opções disponíveis:

en-EN,

es-ES,

pt-BR,

ca-ES,

eu-ES

Parâmetros de caminho

organization_id

string

obrigatório

O identificador único da organização

Maximum string length: 24

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

Parâmetros de consulta

page

integer

padrão:1

Número da página (padrão: 1)

sort

string

Campo de ordenação com sufixo de ordem opcional (:asc ou :desc), por exemplo, "name", "name:asc", "cooldown_minutes:desc". Usa ordem ascendente por padrão se não fornecido sufixo. Campos de ordenação válidos: id, name, description, type, detection_only, cooldown_minutes, enabled, init_text, ok_text, ko_text

fields

string

Lista separada por vírgulas de campos a serem incluídos em cada elemento de fluxo. Campos selecionáveis: id, name, description, type, detection_only, cooldown_minutes, enabled. O campo id sempre é incluído.

Maximum string length: 2048

filters

string

Filtra fluxos por um ou mais critérios. Fornece um objeto JSON com condições de filtro. Você pode filtrar por: id, name, description, type, detection_only, cooldown_minutes, enabled, init_text, ok_text, ko_text. Usa operadores de comparação (eq, ne, gt, gte, lt, lte, in, nin, contains, startsWith, endsWith, between) e combina múltiplas condições com operadores lógicos (and, or). Tamanho máximo: 5120 caracteres.

Maximum string length: 5120

Pattern: ^.*$

per_page

integer

padrão:100

Número de itens por página

Intervalo obrigatório: 1 <= x <= 100

Resposta

Lista paginada de fluxos recuperada corretamente. A resposta inclui metadados de paginação e o conjunto de dados de fluxos.

has_next

boolean

obrigatório

data

object[]

obrigatório

Show child attributes

⌘I

Listar fluxos

curl --request GET \
  --url https://api.flexxible.net/v2/organizations/{organization_id}/flows \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.flexxible.net/v2/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.flexxible.net/v2/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.flexxible.net/v2/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.flexxible.net/v2/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.flexxible.net/v2/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>",
      "type": "session",
      "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>"
  }
}

API Gen 2

Recursos API Gen 2 - v2

Recursos API Gen 2 - v1

Autorizações

Cabeçalhos

Parâmetros de caminho

Parâmetros de consulta

Resposta