Reten Docs
Integración Tareas

Listar Configuraciones de Resultado

Consulta los tipos de resultado disponibles para actividades de tipo tarea.

GET /api/integration/task-result-type-configs

Retorna la lista de tipos de resultado configurados para actividades de tipo tarea en el tenant. Usa esta información para enviar códigos válidos en el campo task_result.result al enviar un resultado.

Autenticación: Requerida — permiso VIEW_ACTIVITIES

Header requerido

HeaderValor
x-api-keyYOUR_API_KEY

Ejemplo

curl -X GET BASE_URL/api/integration/task-result-type-configs \
  -H "x-api-key: YOUR_API_KEY"
const response = await fetch(
  `${BASE_URL}/api/integration/task-result-type-configs`,
  {
    headers: {
      "x-api-key": "YOUR_API_KEY",
    },
  }
);

const configs = await response.json();
import requests

response = requests.get(
    f"{BASE_URL}/api/integration/task-result-type-configs",
    headers={
        "x-api-key": "YOUR_API_KEY",
    },
)

configs = response.json()

Respuesta 200 OK

[
  {
    "code": "SALE_COMPLETED",
    "label": "Venta completada",
    "requiresFutureScheduledAt": false
  },
  {
    "code": "NOT_INTERESTED",
    "label": "No interesado",
    "requiresFutureScheduledAt": false
  },
  {
    "code": "RESCHEDULE",
    "label": "Reprogramar visita",
    "requiresFutureScheduledAt": true
  },
  {
    "code": "NO_CONTACT",
    "label": "Sin contacto",
    "requiresFutureScheduledAt": false
  }
]

Campos de cada configuración

CampoTipoDescripción
codestringIdentificador interno del tipo de resultado — este es el valor que debes enviar en task_result.result al enviar un resultado
labelstringNombre legible del tipo de resultado — este es el texto que debes mostrar al operador en la interfaz de usuario
requiresFutureScheduledAtbooleanSi es true, al enviar un resultado con este código debes incluir task_result.future_scheduled_at con una fecha futura

code y label tienen propósitos distintos. El label (ej. "Venta completada") es lo que el operador (vendedor, callcenter, etc.) ve y selecciona en la interfaz. El code (ej. SALE_COMPLETED) es el identificador interno que tu sistema debe enviar a la API en el campo task_result.result. Nunca envíes el label como resultado — la API solo acepta el code.

Consulta este endpoint antes de enviar resultados para asegurarte de usar códigos válidos. Los tipos de resultado son configurados por el administrador del tenant y pueden variar entre tenants.

Errores

StatusDescripción
401Clave de API faltante o inválida
403La clave no tiene el permiso VIEW_ACTIVITIES