Reten Docs
Activities

List Activities

Get a paginated list of activities with filters.

GET /api/activities

Returns a paginated list of activities with optional filters.

Auth: Required — VIEW_ACTIVITIES permission

Query Parameters

ParameterTypeDefaultDescription
pagenumber1Page number
per_pagenumber25Items per page (max 100)
searchstring-Search activities
statusstring-Filter by status (READY, UNRESOLVED, DISPATCHED, COMPLETED, CANCELED, FAILED)
typestring-Filter by type (TASK, MESSAGE)
channelstring-Filter by channel
commerce_idUUID-Filter by commerce
scheduled_fromISO 8601-Filter from scheduled date
scheduled_toISO 8601-Filter to scheduled date

Example

curl "https://api.reten.ai/api/activities?status=READY&type=TASK&page=1&limit=10" \
  -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',
  {
    params: { status: 'READY', type: 'TASK', page: 1, limit: 10 },
    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",
      "scheduledAt": "2025-01-16T09:00:00.000Z",
      "commerceAssignment": {
        "commerceId": "880e8400-e29b-41d4-a716-446655440000",
        "commerce": {
          "name": "Main Street Store"
        }
      }
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1
  }
}