Listar Configurações de Resultado

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

Retorna a lista de tipos de resultado configurados para atividades do tipo tarefa no tenant. Use essa informação para enviar códigos válidos no campo task_result.result ao enviar um resultado.

Autenticação: Exigida — permissão activity:view

Header exigido

Header	Valor
`x-api-key`	`YOUR_API_KEY`

Exemplo

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()

Resposta `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 configuração

Campo	Tipo	Descrição
`code`	string	Identificador interno do tipo de resultado — este é o valor que você deve enviar em `task_result.result` ao enviar um resultado
`label`	string	Nome legível do tipo de resultado — este é o texto que você deve exibir ao operador na interface de usuário
`requiresFutureScheduledAt`	boolean	Se `true`, ao enviar um resultado com este código você deve incluir `task_result.future_scheduled_at` com uma data futura

code e label têm propósitos diferentes. O label (ex.: "Venta completada") é o que o operador (vendedor, callcenter, etc.) vê e seleciona na interface. O code (ex.: SALE_COMPLETED) é o identificador interno que seu sistema deve enviar à API no campo task_result.result. Nunca envie o label como resultado — a API aceita apenas o code.

Consulte este endpoint antes de enviar resultados para garantir que está usando códigos válidos. Os tipos de resultado são configurados pelo administrador do tenant e podem variar entre tenants.

Erros

Status	Descrição
`401`	Chave de API ausente ou inválida
`403`	A chave não tem a permissão `activity:view`