---
title: "Get a list of webchat sessions."
method: GET
path: "/webchat_sessions"
tags: ["Webchat"]
---

# Get a list of webchat sessions.

`GET /webchat_sessions`

Retrieves a paginated list of webchat sessions for the authenticated customer.

## Query parameters

- `page_size` integer
- `page_token` string
- `widget_id` string, uuid

## Response `200`

A list of webchat sessions.

- object
  - `next_page_token` string — Cursor token for the next page of results. Pass this value as the page_token parameter in the next request.
  - `result` WebchatManagerSession[]
    - `id` string, uuid, required — The unique identifier of the session, and the visitor's continuity token. Returned from the `POST /sessions` or `GET /sessions` response.
    - `customer_id` string, uuid, required — The unique identifier of the associated customer. Returned from the `GET /customers` response.
    - `widget_id` string, uuid, required — The widget this session belongs to. Returned from the `POST /widgets` or `GET /widgets` response.
    - `status` 'active' | 'ended', required — The status of the session.
    - `page_url` string — The URL of the page the widget was embedded on when this session was created. Captured client-side from window.location.href at session-creation time; not re-captured on subsequent navigation within the same session.
    - `referrer` string — document.referrer at session-creation time -- the page the visitor was on immediately before arriving at the page that embeds the widget. Distinct from page_url (the page the widget is currently embedded on). Captured client-side; not re-captured on subsequent navigation within the same session.
    - `peer` CommonAddress — Contains source or destination detail info.
      - `type` '' | 'agent' | 'conference' | 'email' | 'extension' | 'line' | 'sip' | 'tel' | 'web_session' — Type of address.
      - `target` string — The address endpoint. Format depends on type: phone number for tel (e.g. +14155551234), UUID for agent/conference/extension, email for email, SIP URI for sip.
      - `target_name` string — Address's name.
      - `name` string — Optional label for this address.
      - `detail` string — Additional notes about this address.
    - `local` CommonAddress — Contains source or destination detail info.
      - `type` '' | 'agent' | 'conference' | 'email' | 'extension' | 'line' | 'sip' | 'tel' | 'web_session' — Type of address.
      - `target` string — The address endpoint. Format depends on type: phone number for tel (e.g. +14155551234), UUID for agent/conference/extension, email for email, SIP URI for sip.
      - `target_name` string — Address's name.
      - `name` string — Optional label for this address.
      - `detail` string — Additional notes about this address.
    - `tm_last_activity` string, date-time — Timestamp of the last activity on this session.
    - `tm_create` string, date-time — Timestamp when the session was created.
    - `tm_update` string, date-time — Timestamp when the session was last updated.
    - `tm_end` string, date-time — Timestamp when the session ended.

## Other responses

- `401` — Authentication required (UNAUTHENTICATED).
- `500` — Internal error (INTERNAL).

---

[API](https://skmtc.net/voipbin/apis/voipbin-api.md) · [All operations](https://skmtc.net/voipbin/apis/voipbin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voipbin/voipbin-api/revisions/79e779080bcc/schema)