Este endpoint obtiene un resumen general de un tablero (flow). En particular, obtiene un objeto con las siguientes características:
status que contiene un array de todos los estados existentes, cada uno con su id y nombre. Estos id de estados se utilizan en el endpoint Ejecutar transición para un Dealfield, siendo cada una un objeto que describe un variable del deal configurada para el tablero. Cada objeto contiene el nombre de la variable, su tipo y toda la información relevante que se necesita para rellenarla. Esta información se utiliza en el endpoint Crear Dealcrm/integration-generic/flows/:flowId
GET
Este endpoint requiere autorización según se indica en Authorization
| Nombre del dato | Tipo Dato | Descripción | Requerido |
|---|---|---|---|
flowId |
string (UUID) | UUID único del tablero (flow) en formato xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx |
Si |
| 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. |
{
"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...
}