Reten Docs
Task Activities

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 — VIEW_ACTIVITIES permission

Query Parameters

ParameterTypeDefaultDescription
pagenumber1Page number
per_pagenumber25Items per page (max 100)
searchstring-Search task activities
statusstring-Filter by activity status
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

Example

curl "https://api.reten.ai/api/activities/tasks?routeId=<routeId>&status=READY" \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>"
import axios from 'axios';

const response = await axios.get(
  'https://api.reten.ai/api/activities/tasks',
  {
    params: { routeId: '<routeId>', status: 'READY' },
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

const { data, meta } = response.data;

Response 200 OK

{
  "data": [
    {
      "id": "ee0e8400-e29b-41d4-a716-446655440000",
      "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" }
      }
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1
  }
}