---
title: "List Text Sessions"
method: GET
path: "/api/v1/text-ai/text-sessions"
tags: ["text-ai", "text_sessions"]
deprecated: true
---

# List Text Sessions

`GET /api/v1/text-ai/text-sessions`

> **Deprecated.**

List text sessions with pagination and optional filters.

## Query parameters

- `text_widget_group_id` string, uuid, nullable
- `was_transferred` boolean, nullable
- `contact_source` string, nullable
- `outcome` 'voicemail' | 'missed_by_system' | 'transferred' | 'handled_end_to_end', nullable
- `has_first_response` boolean, nullable — Filter to sessions where the AI produced a first response (population behind the avg-first-response widget).
- `has_ended` boolean, nullable — Filter to sessions that have ended (population behind the avg-resolution-time widget).
- `local_hour_of_day` integer, nullable — Filter to sessions stamped at this tenant-local hour (0-23); heatmap cell drill.
- `local_day_of_week` integer, nullable — Filter to sessions stamped on this tenant-local weekday (0=Mon..6=Sun); heatmap cell drill.
- `buckets` string[], nullable — Filter to sessions in any of these attribution buckets — the drill of a bucket-grouped cell or a bucket filter.
- `dispositions` string[], nullable — Filter to sessions in any of these terminal dispositions — the drill of a disposition-set measure (e.g. Missed & Abandoned).
- `needs_owner_review` boolean, nullable — When true, returns only sessions where a human participated but the outcome owner is not credited to a human (unattributed worklist).
- `use_created_at` boolean, nullable — Deprecated - use date_field=created_at.
- `limit` integer, nullable
- `offset` integer, nullable
- `page` integer, nullable — Deprecated - use offset.
- `per_page` integer, nullable — Deprecated - use limit.
- `start_date` string, date, nullable
- `end_date` string, date, nullable
- `date_field` string, nullable — Which timestamp the date range filters. Valid values differ per subject; an unknown one is a 422 listing them.
- `date_from` string, date-time, nullable — Deprecated - use start_date.
- `date_to` string, date-time, nullable — Deprecated - use end_date.
- `property_ids` string[], nullable
- `property_ids_exclude` string[], nullable
- `include_considered_hotels` boolean, nullable — Include hotels the conversation was only considered for, not just the one it was attributed to.
- `agent_id` string, uuid, nullable
- `outcome_agent_ref` string, nullable
- `outcome_agent_refs` string[], nullable
- `outcome_agent_refs_exclude` string[], nullable
- `outcome_agent_kind` 'ai_voice' | 'ai_text' | 'human', nullable
- `reviewed` boolean, nullable
- `status` string, nullable
- `has_booking_intent` boolean, nullable
- `has_booking` boolean, nullable
- `booking_made` boolean, nullable
- `booking_attributed` boolean, nullable
- `tag_ids` string[], nullable
- `country` string, nullable
- `is_after_hours` boolean, nullable
- `population_filters` string[], nullable — Named conversation-population filters: business_hours, min_call_25s, real_customer_message, exclude_spam_test, dedupe_24h.
- `search` string, nullable
- `standard_filters` string, nullable
- `metric_filters` string, nullable
- `sort_by` string, nullable
- `sort_order` 'asc' | 'desc', nullable
- `strict` boolean — Reject filters this subject cannot apply with a 422, instead of returning a wider population and reporting them in ignored_filters.
- `voice_agent_id` string, uuid, nullable — Deprecated - use agent_id.
- `metric_id` string, uuid, nullable — Deprecated - use metric_filters.
- `metric_state` 'pass' | 'fail' | 'na' | 'not_run' | 'error', nullable — Deprecated - use metric_filters.
- `booking_intent` boolean, nullable — Deprecated - use has_booking_intent.

## Response `200`

Successful Response

- LogListResponseTextSessionListItem
  - `items` TextSessionListItem[], required
    - `id` string, uuid, required
    - `text_agent_id` string, uuid, nullable, required
    - `status` string, required
    - `visitor_name` string, nullable, required
    - `visitor_email` string, nullable, required
    - `message_count` integer, required
    - `started_at` string, date-time, nullable, required
    - `ended_at` string, date-time, nullable, required
    - `created_at` string, date-time, required
    - `session_metadata` object, nullable
    - `handoff_status` string, nullable
    - `is_new` boolean, required
    - `email_verified` boolean, required
    - `review_status` string, required
    - `applied_tags` ConversationTagRead[]
      - `id` string, uuid, required
      - `voice_call_id` string, uuid, nullable, required
      - `text_session_id` string, uuid, nullable, required
      - `tag_definition_id` string, uuid, required
      - `is_primary` boolean, required
      - `source` string, required
      - `applied_by_user_id` string, uuid, nullable, required
      - `confidence` number, nullable, required
      - `model_version` string, nullable, required
      - `created_at` string, date-time, required
      - `tag_definition` TagDefinitionRead
        - `id` string, uuid, required
        - `name` string, required
        - `slug` string, required
        - `color` 'default' | 'neutral' | 'success' | 'error' | 'warning' | 'danger' | 'info' | 'purple' | 'pink' | 'teal' | 'orange' | 'indigo' | 'slate', required
        - `icon` string, nullable
        - `description` string, nullable, required
        - `dimension` string, required
        - `parent_id` string, uuid, nullable, required
        - `deprecated_at` string, date-time, nullable, required
        - `created_by_user_id` string, uuid, nullable, required
        - `created_at` string, date-time, required
        - `updated_at` string, date-time, required
    - `is_after_hours` boolean, nullable
    - `outcome_agent_ref` string, nullable
    - `outcome` string, nullable
    - `disposition` string, nullable
    - `was_transferred` boolean
    - `transfer_destination` string, nullable
    - `transfer_mode` string, nullable
    - `human_handoff_completed_at` string, date-time, nullable
    - `booking_made` boolean, nullable
    - `booking_intent` boolean
    - `booking_status` string, nullable
    - `booking_value_cents` integer, nullable
    - `booking_value_currency` string, nullable
    - `attribution_bucket` string, nullable
    - `contact_source` string, nullable
    - `active_seconds` integer, nullable
    - `first_ai_response_at` string, date-time, nullable
    - `local_hour_of_day` integer, nullable
    - `local_day_of_week` integer, nullable
    - `is_repeat_caller` boolean
    - `primary_property_id` string, uuid, nullable
    - `primary_property_name` string, nullable
  - `total` integer, required — Rows matching the filters, in `total_unit`s.
  - `limit` integer, required — Page size actually applied.
  - `offset` integer, required — Rows skipped.
  - `has_more` boolean, required — Whether another page exists.
  - `total_unit` 'logical_call' | 'row' — What `total` counts. `row` for text, email and bookings. `voice` returns `logical_call`, because a transferred call is several legs in `items` but one call in `total` — so a caller that counts `items` will legitimately disagree with `total`.
  - `applied_filters` string[] — Filters that were compiled into the query.
  - `ignored_filters` IgnoredFilter[] — Filters accepted but NOT applied by this subject, each with the reason. Send `strict=true` to make these a 422 instead.
    - `key` string, required — The query parameter that was not applied.
    - `reason` string, required — Operator-facing explanation, from the subject registry. This is the same sentence the UI shows in the disabled control's tooltip.
  - `page` integer, nullable — Deprecated — derive from `offset`/`limit`.
  - `per_page` integer, nullable — Deprecated — use `limit`.

## Other responses

- `401` — Authentication required
- `403` — Missing the required permission for these logs
- `422` — Invalid parameters: conflicting deprecated alias, inverted date range, unknown date_field, unsupported sort_by, or — with strict=true — a filter this subject cannot apply

---

[API](https://skmtc.dev/getanana/apis/cleon-api.md) · [All operations](https://skmtc.dev/getanana/apis/cleon-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getanana/cleon-api/revisions/c0f54348e251/schema)
