Ingresar
DocumentaciónGuíasReferenciaWebhooksRecursos
Flujos

Listar flujos

Sirve para listar tus flujos de automatización con filtros por carpeta, disparador, estado, número o fecha, por ejemplo para mostrarlos en tu producto o auditarlos.

GET
/flows

Permiso requerido: conversations:read

Autorización

http
headerAuthorizationBearer <clave>

Parámetros de consulta

name?string
folder_id?integer
unclassified?string
trigger_type?string
Valor en"1""2""3""4""5""6""7""inbound_automation"
status?string
Valor en"active""inactive"
date_from?string
Formatodate
date_to?string
Formatodate
date_field?string
Valor en"created_at""updated_at"
device_id?string
device_ids[]?array<>
perPage?integer
Rango1 <= value <= 100
Por defecto25
orderBy?string
Valor en"name""created_at""updated_at"
orderByMethod?string
Valor en"asc""desc"

Cuerpo de la respuesta

OK

application/json
  1. response
data*array<>
links*
meta*
curl -X GET "https://example.com/flows"
{  "data": [    {      "id": "string",      "name": "string",      "uuid": "string",      "first_node_uuid": "string",      "enable": "string",      "valid": "string",      "executions": "string",      "created_at": "string",      "updated_at": "string",      "nodes_count": "string",      "trigger_uuid": "string",      "trigger_device_ids": "string",      "trigger_type": "string",      "trigger_values": "string",      "trigger_is_global": true,      "trigger_save_activation_phrase": true,      "trigger_activation_phrase_field_id": "string",      "payment_platform": "string",      "payment_external_product_id": "string",      "payment_event_types": "string",      "payment_event_entry_nodes": "string",      "default": "string",      "once_per_contact": "string",      "frequency_limit_value": "string",      "frequency_limit_unit": "string",      "frequency_limit_minutes": "string",      "folder": {        "id": "string",        "name": "string",        "parent_id": "string",        "children": [          {}        ],        "flows_count": 0      },      "nodes": [        {          "uuid": "string",          "flow_id": "string",          "type": 0,          "action": "string",          "value": "string",          "next_uuid": "string"        }      ],      "inbound_origins": "string",      "intention_prompt": "string",      "match_location": "string",      "match_details": "string",      "risk_acceptance": {        "accepted_by_name": "string",        "accepted_at": "string",        "codes": "string"      }    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 0,    "from": 0,    "last_page": 0,    "links": [      {        "url": "string",        "label": "string",        "active": true      }    ],    "path": "string",    "per_page": 0,    "to": 0,    "total": 0  }}

Cancelar un flujo en curso PUT

Usalo para frenar un flujo que está corriendo para un contacto, por ejemplo cuando tu sistema detecta que ya compró o pidió no recibir más mensajes.

Ver un flujo GET

Usalo para ver la configuración de un flujo: si está activo y es válido, cuántas veces se ejecutó y qué lo dispara (tipo, valores y números).