Reten Docs

List Result Configurations

Query the available result types for task-type activities.

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

Returns the list of result types configured for task-type activities in the tenant. Use this information to send valid codes in the task_result.result field when submitting a result.

Authentication: Required — permission VIEW_ACTIVITIES

Required header

HeaderValue
x-api-keyYOUR_API_KEY

Example

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

Response 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
  }
]

Configuration fields

FieldTypeDescription
codestringInternal result type identifier — this is the value you must send in task_result.result when submitting a result
labelstringHuman-readable result type name — this is the text you should display to the operator in the user interface
requiresFutureScheduledAtbooleanIf true, when submitting a result with this code you must include task_result.future_scheduled_at with a future date

code and label serve different purposes. The label (e.g., "Venta completada") is what the operator (salesperson, call center, etc.) sees and selects in the interface. The code (e.g., SALE_COMPLETED) is the internal identifier that your system must send to the API in the task_result.result field. Never send the label as the result — the API only accepts the code.

Query this endpoint before submitting results to ensure you are using valid codes. Result types are configured by the tenant administrator and may vary between tenants.

Errors

StatusDescription
401API key missing or invalid
403The key does not have the VIEW_ACTIVITIES permission