Descripción

Este endpoint obtiene un resumen general de un tablero (flow). En particular, obtiene un objeto con las siguientes características:

Ruta

crm/integration-generic/flows/:flowId

Método

GET

Autorización

Este endpoint requiere autorización según se indica en Authorization

Parámetros de entrada (path params)

Nombre del dato Tipo Dato Descripción Requerido
flowId string (UUID) UUID único del tablero (flow) en formato xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx Si

Parámetros de salida (data)

Nombre del dato Tipo Dato Descripción
flow string (UUID) UUID del tablero
status Array de objetos Array de objetos status en que cada uno contiene el id y nombre de una columna del tablero
…fields (varios) objeto field Objeto que describe una variable del tablero. Se incluye su nombre, tipo e información relevante para rellenarla. La candidad de llaves distintas field que lleguen depende de la cantidad de columnas del tablero.

Ejemplo objeto de salida (data)

{
	"flow": "9148d6e8-1714-46ba-xxxx-xxxxxxxxxxxx",
	"status": [
		{
        "id": 559,
        "name": "Emitidos"
    },
    {
        "id": 560,
        "name": "Contactados"
    },
	],
	"address": {
		"name": "address",
    "type": "string",
    "options": {
	    // ...
    },
    values: []
	},
	"email": {
		"name": "email",
		"type": "string",
		"options": {
			// ...
		},
		values: []
	},
	// other fields...
}