Reten Docs

List Task Activities

Get a paginated list of TASK activities with route/operator filters.

GET /api/activities/tasks

Returns a paginated list of TASK-type activities with additional route and operator filters.

Auth: Required — activity:view permission

Query Parameters

ParameterTypeDefaultDescription
pagenumber1Page number
per_pagenumber25Items per page (max 100)
searchstring-Search task activities
statusstring-Filter by activity status (see Activity States). Filterable values: READY, RETRYING, DISPATCHED, COMPLETED, CANCELED, FAILED
channelstring-Filter by channel
commerce_idUUID-Filter by commerce
assigned_route_idUUID-Filter by assigned route
assigned_operator_idUUID-Filter by assigned operator
scheduled_fromISO 8601-Filter from scheduled date
scheduled_toISO 8601-Filter to scheduled date
result_statusstring-Filter by latest result status — see Activity States §resultStatus. Filterable values: COMPLETED, NOT_EXECUTED

Example

curl "https://api.reten.ai/api/activities/tasks?routeId=<routeId>&status=READY" \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "x-project-id: <project-id>"
const params = new URLSearchParams({ assigned_route_id: "<routeId>", status: "READY" });
const response = await fetch(`https://api.reten.ai/api/activities/tasks?${params}`, {
  headers: {
    "Authorization": "Bearer <token>",
    "x-tenant-id": "<tenant-id>",
    "x-project-id": "<project-id>",
  },
});
const data = await response.json();
import requests

response = requests.get(
    "https://api.reten.ai/api/activities/tasks",
    headers={
        "Authorization": "Bearer <token>",
        "x-tenant-id": "<tenant-id>",
        "x-project-id": "<project-id>",
    },
    params={"assigned_route_id": "<routeId>", "status": "READY"},
)
data = response.json()

Response 200 OK

{
  "data": [
    {
      "id": "ee0e8400-e29b-41d4-a716-446655440000",
      "projectId": "3f6c2b1a-8d4e-4f7a-9b2c-5e1d0a7f6c34",
      "type": "TASK",
      "channel": "SALESMAN",
      "status": "READY",
      "taskDetails": {
        "assignedRouteId": "dd0e8400-e29b-41d4-a716-446655440000",
        "assignedOperatorId": "cc0e8400-e29b-41d4-a716-446655440000",
        "route": { "name": "North Zone" },
        "operator": { "firstName": "John", "lastName": "Doe" }
      },
      "commerceAssignment": {
        "commerce": { "name": "Main Street Store" }
      }
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 1,
    "total_pages": 1,
    "has_next": false,
    "has_previous": false
  }
}