---
title: "Sessions List"
method: GET
path: "/api/v1/sessions/"
tags: ["sessions"]
---

# Sessions List

`GET /api/v1/sessions/`

## Query parameters

- `page` integer, nullable — The page number from which to start (0-based)
- `limit` integer — The maximum number of items to return
- `search_fields` SessionProperties[] — String names of fields to search. Correspond by index to search field values
- `search_field_values` string[] — Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list
- `order_by` 'timestamp' | 'session_id' | 'conversation_id' | 'channel_manager_service' | 'channel_manager_type' | 'channel_manager_sid' | 'agent_type' | 'agent_id' | 'agent_name' | 'prompt_id' | 'prompt_name' | 'source' | 'target' | 'duration' | 'is_outbound' | 'is_legacy' | 'is_test' — Names of session fields supported for filtering/sorting on list endpoint.
- `order_by_direction` 'asc' | 'desc' — The direction in which to order list results, either ascending or descending.
- `fields` SessionProperties[], nullable — The fields to include in the response
- `start_datetime` string, nullable — The start datetime for filtering results
- `end_datetime` string, nullable — The end datetime for filtering results

## Response `200`

Successful Response

- ListResponseSession
  - `items` Session[], required — List of items returned from the query
    - `timestamp` string, date-time, required — Timestamp of the session
    - `session_id` string, nullable — Internal ID of the session, generated based on interaction details
    - `conversation_id` string, nullable — ID of the conversation of which the session is a part
    - `channel_manager_service` string, nullable — Name of the service used to facilitate the session
    - `channel_manager_type` string, nullable — Type of the service used to facilitate the session
    - `channel_manager_sid` string, nullable — Channel-manager-side ID of the session (different from session_id)
    - `agent_id` string, nullable — ID of the agent with which the session occurred
    - `agent_name` string, nullable — Name of the agent with which the session occurred
    - `agent_type` string, nullable — Type of the agent with which the session occurred
    - `agent_timezone` string, nullable — Timezone of the agent with which the session occurred
    - `prompt_id` string, nullable — ID of the prompt used by the agent with which the session occurred
    - `prompt_name` string, nullable — Name of the prompt used by the agent with which the session occurred
    - `prompt_version` string, nullable — Legacy prompt version timestamp used by the agent with which the session occurred
    - `prompt_version_number` integer, nullable — Prompt version number used by the agent with which the session occurred (new system)
    - `duration` number, nullable — Duration of the session in seconds
    - `session_label_id` string, nullable — ID of the label (listing the quality of the session and any issues that occurred) associated with the session
    - `source` string, nullable — Source of the session (e.g., for an inbound session, the user's phone number/username/email)
    - `target` string, nullable — The name of the channel target associated with the agent at the time of the session (see ChannelTargetResponse.target)
    - `is_legacy` boolean, nullable — Whether the session occurred on the legacy Syllable system
    - `is_test` boolean, nullable — Whether the session is a test session
    - `is_outbound` boolean, nullable — Whether the session direction is outbound (true) or inbound (false).
    - `user_terminated` boolean, nullable — Whether the voice session was ended by the recipient (outbound) / caller (inbound). False if the user was transferred or there was an error. Unset if the session was not a voice session.
    - `transfer_voicemail_detected` boolean, nullable — Whether a voicemail was detected during the transfer leg of the session
    - `override_timestamp` string, nullable — ISO 8601 datetime used to override the session's current time. Set only for test sessions that supplied a datetime override; otherwise null.
  - `page` integer, required — The page number of the results (0-based)
  - `page_size` integer, required — The number of items returned per page
  - `total_pages` integer, nullable — The total number of pages of results given the indicated page size
  - `total_count` integer, nullable — The total number of items returned from the query

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/asksyllable/apis/syllablesdk.md) · [All operations](https://skmtc.net/asksyllable/apis/syllablesdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/asksyllable/syllablesdk/versions/ac3228f980bb/schema)