---
title: "Get a chat"
method: GET
path: "/chats/{chat}"
tags: ["Chats"]
---

# Get a chat

`GET /chats/{chat}`

## Request

- Base URL: `https://vocenya.com/api/public/v1`
- URL: `https://vocenya.com/api/public/v1/chats/{chat}`
- Auth: HTTP bearer

One chat with its messages. HIPAA-mode accounts get the chat without messages or handoff summary.

## Path parameters

- `chat` integer, required

## Response `200`

`ChatResource`

- object
  - `data` ChatResource, required
    - `id` integer, required
    - `livemode` boolean, required: `true` for live data, `false` for test data (created with a `vk_test_` key).
    - `channel` string, required: Where the chat happens: `web` (the website widget), `whatsapp` or `sms` (texts to your Vocenya number).
    - `contact_address` string, nullable, required: The customer's number in E.164 on `whatsapp` and `sms` chats; `null` on website chats.
    - `reply_window_open` boolean, nullable, required: On `whatsapp` chats, whether WhatsApp's 24-hour window for free-form replies is open now.
    - `status` 'ai' | 'with_agent' | 'with_owner' | 'closed', required: Who is answering a website chat right now.
    - `page_url` string, nullable, required
    - `handoff_summary` string, nullable: What the AI passed on when it handed the chat to a person. Not included for HIPAA-mode accounts.
    - `handed_off_at` string, nullable, required
    - `closed_at` string, nullable, required
    - `last_message_at` string, nullable, required
    - `lead_id` integer, nullable, required: The lead the AI captured in this chat, if any.
    - `messages` object[]: The conversation. Only on `GET /chats/{id}`, and never for HIPAA-mode accounts.
      - `id` integer, required
      - `livemode` boolean, required
      - `sender` string, required
      - `role` 'visitor' | 'ai' | 'team' | 'system', required
      - `author` string, required
      - `body` string, required
      - `via_api` boolean, required
      - `created_at` string, nullable, required
    - `created_at` string, nullable, required

## Other responses

- `401`: The API key is missing, invalid, expired or revoked.
- `403`: The key does not have the `chats:read` scope.
- `404`: No record with that id belongs to your account.
- `429`: Too many requests for this key. Wait for the `Retry-After` seconds.

---

[API](https://skmtc.dev/vocenya/apis/vocenya-api.md) · [All operations](https://skmtc.dev/vocenya/apis/vocenya-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vocenya/apis/vocenya-api/revisions/946913941565?raw)