Integración Tareas
Listar Actividades Consulta las actividades de tipo tarea visibles para tu integración.
Retorna una lista paginada de actividades de tipo tarea visibles para la clave de API de tu integración.
Autenticación : Requerida — permiso VIEW_ACTIVITIES
Header Valor x-api-keyYOUR_API_KEY
Parámetro Tipo Requerido Descripción pagenumber No Número de página (por defecto: 1) per_pagenumber No Resultados por página (por defecto: 20, máximo: 100) statusstring No Filtrar por estado de actividad (ver Activity States ). Valores filtrables: READY, RETRYING, DISPATCHED, COMPLETED, CANCELED, FAILEDVer detalle result_statusstring No Filtrar por estado del resultado (ver Activity States ). Valores filtrables: COMPLETED, NOT_EXECUTEDVer detalle channelstring No Filtrar por canal (SALESMAN, CALLCENTER, etc.) external_commerce_idstring No Filtrar por ID externo del comercio external_operator_idstring No Filtrar por ID externo del operador scheduled_fromstring No Fecha mínima de programación (ISO 8601) scheduled_tostring No Fecha máxima de programación (ISO 8601)
cURL TypeScript Python
curl -X GET "BASE_URL/api/integration/activities/tasks?page=1&per_page=10&status=READY" \ -H "x-api-key: YOUR_API_KEY" const params = new URLSearchParams ({ page: "1" , per_page: "10" , status: "READY" , }); const response = await fetch ( `${ BASE_URL }/api/integration/activities/tasks?${ params }` , { headers: { "x-api-key" : "YOUR_API_KEY" , }, } ); const data = await response. json (); import requests response = requests.get( f " {BASE_URL} /api/integration/activities/tasks" , headers = { "x-api-key" : "YOUR_API_KEY" , }, params = { "page" : 1 , "per_page" : 10 , "status" : "READY" , }, ) data = response.json()
El siguiente es un ejemplo ilustrativo de la forma del response. Los valores de campos como id, scheduledAt, status, lifecycleStatus, etc., varían según el estado real de cada actividad. Para el catálogo completo de posibles valores de status y lifecycleStatus, ver Activity States .
{ "data" : [ { "id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890" , "activityOrigin" : "ACTIVITY" , "type" : "TASK" , "status" : "READY" , "score" : 85 , "channel" : "SALESMAN" , "scheduledAt" : "2026-12-01T09:00:00.000Z" , "occurredAt" : null , "createdAt" : "2026-04-10T14:30:00.000Z" , "lifecycleStatus" : "SCHEDULED" , "lifecycleStatusLabel" : "Programada" , "lifecycleStatusDetail" : null , "canForceRetryDispatch" : false , "commerceExternalId" : "COM-001" , "commerceName" : "Farmacia Central" , "reason" : { "code" : "CHURN_RISK" , "label" : "Riesgo de fuga" }, "userStatus" : null , "commerceAssignment" : { "commerceExternalId" : "COM-001" , "assignmentReason" : "Asignación por ruta" , "commerce" : { "externalId" : "COM-001" , "name" : "Farmacia Central" } }, "activityDetails" : { "type" : "TASK" , "assignedRouteCode" : "RUTA-NORTE-01" , "assignedOperatorExternalId" : "OP-042" , "assignedRoute" : { "code" : "RUTA-NORTE-01" , "name" : "Ruta Norte" }, "assignedOperator" : { "externalId" : "OP-042" , "name" : "Carlos Pérez" , "type" : "SALESMAN" } }, "activityResult" : null } ], "meta" : { "page" : 1 , "per_page" : 10 , "total" : 47 , "totalPages" : 5 } } Campo Tipo Descripción idstring Identificador único de la actividad activityOrigin"ACTIVITY" | "STANDALONE"Origen de la actividad typestring | null Tipo de actividad (ej. "TASK") statusstring | null Estado actual de la actividad — ver Activity States para el catálogo completo scorenumber | null Puntuación de prioridad de la actividad (asignada al crearla) channelstring | null Canal de la actividad (SALESMAN, CALLCENTER, etc.) scheduledAtstring | null Fecha programada (ISO 8601) occurredAtstring | null Fecha en que ocurrió la gestión (ISO 8601) createdAtstring | null Fecha de creación (ISO 8601) lifecycleStatusstring | null Estado del ciclo de vida para visualización (read-only, computed) — ver Activity States lifecycleStatusLabelstring | null Etiqueta legible del estado del ciclo de vida lifecycleStatusDetailstring | null Detalle adicional del estado canForceRetryDispatchboolean Indica si se puede forzar un re-dispatch commerceExternalIdstring ID externo del comercio asociado commerceNamestring Nombre del comercio reasonobject | null Razón de la actividad (code, label) userStatusobject | null Estado personalizado del usuario (code, label) commerceAssignmentobject | null Información de asignación del comercio activityDetailsobject | null Detalles específicos del tipo de actividad activityResultobject | null Resultado de la gestión (si existe)
Campo Tipo Descripción type"TASK"Discriminador de tipo assignedRouteCodestring | null Código de la ruta asignada assignedOperatorExternalIdstring | null ID externo del operador asignado assignedRouteobject | null Ruta asignada (code, name) assignedOperatorobject | null Operador asignado (externalId, name, type)
Campo Tipo Descripción idstring Identificador del resultado resultStatusstring Estado del resultado — ver Activity States §Related enums → ActivityResultStatusEnum sourcestring Origen del resultado originstring Canal de origen channelstring | null Canal del resultado occurredAtstring Fecha en que ocurrió (ISO 8601) createdAtstring Fecha de creación (ISO 8601) resultDetailsobject | null Detalles del resultado de tipo tarea
Status Descripción 401Clave de API faltante o inválida 403La clave no tiene el permiso VIEW_ACTIVITIES