List Activities

GET /api/integration/activities/tasks

Returns a paginated list of task-type activities visible to your integration's API key.

Authentication: Required — permission VIEW_ACTIVITIES

Required header

Header	Value
`x-api-key`	`YOUR_API_KEY`

Query parameters

Parameter	Type	Required	Description
`page`	number	No	Page number (default: `1`)
`per_page`	number	No	Results per page (default: `20`, max: `100`)
`status`	string	No	Filter by activity status (`PENDING`, `IN_PROGRESS`, `COMPLETED`, `CANCELLED`)
`result_status`	string	No	Filter by result status (`EFFECTIVE`, `NOT_EFFECTIVE`, `PENDING`)
`channel`	string	No	Filter by channel (`SALESMAN`, `CALLCENTER`, etc.)
`external_commerce_id`	string	No	Filter by commerce external ID
`external_operator_id`	string	No	Filter by operator external ID
`scheduled_from`	string	No	Minimum scheduled date (ISO 8601)
`scheduled_to`	string	No	Maximum scheduled date (ISO 8601)

Example

curl -X GET "BASE_URL/api/integration/activities/tasks?page=1&per_page=10&status=PENDING" \
  -H "x-api-key: YOUR_API_KEY"

const params = new URLSearchParams({
  page: "1",
  per_page: "10",
  status: "PENDING",
});

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": "PENDING",
    },
)

data = response.json()

Response `200 OK`

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "activityOrigin": "ACTIVITY",
      "type": "TASK",
      "status": "PENDING",
      "channel": "SALESMAN",
      "scheduledAt": "2026-04-15T09: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
  }
}

Activity fields

Field	Type	Description
`id`	string	Unique activity identifier
`activityOrigin`	`"ACTIVITY"` \| `"STANDALONE"`	Activity origin
`type`	string \| null	Activity type (e.g., `"TASK"`)
`status`	string \| null	Current status (`PENDING`, `IN_PROGRESS`, `COMPLETED`, `CANCELLED`)
`channel`	string \| null	Activity channel (`SALESMAN`, `CALLCENTER`, etc.)
`scheduledAt`	string \| null	Scheduled date (ISO 8601)
`occurredAt`	string \| null	Date when the activity was handled (ISO 8601)
`createdAt`	string \| null	Creation date (ISO 8601)
`lifecycleStatus`	string \| null	Lifecycle status for display purposes
`lifecycleStatusLabel`	string \| null	Human-readable lifecycle status label
`lifecycleStatusDetail`	string \| null	Additional status detail
`canForceRetryDispatch`	boolean	Indicates whether a re-dispatch can be forced
`commerceExternalId`	string	External ID of the associated commerce
`commerceName`	string	Commerce name
`reason`	object \| null	Activity reason (`code`, `label`)
`userStatus`	object \| null	Custom user status (`code`, `label`)
`commerceAssignment`	object \| null	Commerce assignment information
`activityDetails`	object \| null	Type-specific activity details
`activityResult`	object \| null	Activity result (if exists)

`activityDetails` fields (TASK type)

Field	Type	Description
`type`	`"TASK"`	Type discriminator
`assignedRouteCode`	string \| null	Assigned route code
`assignedOperatorExternalId`	string \| null	Assigned operator external ID
`assignedRoute`	object \| null	Assigned route (`code`, `name`)
`assignedOperator`	object \| null	Assigned operator (`externalId`, `name`, `type`)

`activityResult` fields

Field	Type	Description
`id`	string	Result identifier
`resultStatus`	string	Result status (`EFFECTIVE`, `NOT_EFFECTIVE`, `PENDING`)
`source`	string	Result source
`origin`	string	Origin channel
`channel`	string \| null	Result channel
`occurredAt`	string	Date when it occurred (ISO 8601)
`createdAt`	string	Creation date (ISO 8601)
`resultDetails`	object \| null	Task result details

Errors

Status	Description
`401`	API key missing or invalid
`403`	The key does not have the `VIEW_ACTIVITIES` permission