> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Unipile: Get Chat

> Get one chat/conversation by chat_id. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get one chat/conversation by chat\_id.

> [!NOTE]
>
> Tool ID: `unipile_get_chat`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'unipile_get_chat',
  {
    "chat_id": "chat_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute unipile_get_chat --input '{
  "chat_id": "chat_123"
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe unipile_get_chat --json` for the complete live contract.

## Input reference

Retrieve the details of a chat.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.account_id` | `string` | No | — | Mandatory if the chat ID is a provider ID. |
| `payload.chat_id` | `string` | Yes | — | The Unipile or provider ID of the chat. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieve the details of a chat.",
    "properties": {
      "account_id": {
        "type": "string",
        "description": "Mandatory if the chat ID is a provider ID."
      },
      "chat_id": {
        "type": "string",
        "description": "The Unipile or provider ID of the chat."
      }
    },
    "required": [
      "chat_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.id` | `string` | Yes | — | A unique identifier. Minimum length: 1. |
| `result.data.account_id` | `string` | Yes | — | A unique identifier. Minimum length: 1. |
| `result.data.account_type` | `"WHATSAPP" \| "LINKEDIN" \| "SLACK" \| "TWITTER" \| "MESSENGER" \| "INSTAGRAM" \| "TELEGRAM"` | Yes | — | — |
| `result.data.provider_id` | `string` | Yes | — | — |
| `result.data.attendee_provider_id` | `string` | No | — | — |
| `result.data.name` | `string \| null` | Yes | — | — |
| `result.data.type` | `0 \| 1 \| 2` | Yes | — | — |
| `result.data.timestamp` | `string \| null` | Yes | — | — |
| `result.data.unread_count` | `number` | Yes | — | — |
| `result.data.archived` | `0 \| 1` | Yes | — | — |
| `result.data.muted_until` | `-1 \| string \| null` | Yes | — | — |
| `result.data.read_only` | `0 \| 1 \| 2` | Yes | — | — |
| `result.data.disabledFeatures` | `array` | No | — | — |
| `result.data.subject` | `string` | No | — | — |
| `result.data.organization_id` | `string` | No | — | Linkedin specific ID for organization mailboxes. |
| `result.data.mailbox_id` | `string` | No | — | Linkedin specific ID for organization mailboxes. |
| `result.data.content_type` | `"inmail" \| "sponsored" \| "linkedin_offer"` | No | — | — |
| `result.data.folder` | `array` | No | — | — |
| `result.data.pinned` | `0 \| 1` | Yes | — | — |
| `result.data.object` | `"Chat"` | Yes | — | Allowed: `Chat`. |
| `result.data.lastMessage` | `object \| null` | Yes | — | — |
| `result.data.lastMessage.message_id` | `string` | No | — | A unique identifier. Minimum length: 1. |
| `result.data.lastMessage.provider_id` | `string` | Yes | — | — |
| `result.data.lastMessage.sender_id` | `string` | Yes | — | — |
| `result.data.lastMessage.text` | `string \| null` | Yes | — | — |
| `result.data.lastMessage.attachments` | `array` | Yes | — | — |
| `result.data.lastMessage.attachments[].id` | `string` | Yes | — | — |
| `result.data.lastMessage.attachments[].file_size` | `number` | No | — | — |
| `result.data.lastMessage.attachments[].unavailable` | `boolean` | Yes | — | — |
| `result.data.lastMessage.attachments[].mimetype` | `string` | No | — | — |
| `result.data.lastMessage.attachments[].url` | `string` | No | — | — |
| `result.data.lastMessage.attachments[].url_expires_at` | `number` | No | — | — |
| `result.data.lastMessage.attachments[].type` | `"img"` | Yes | — | — |
| `result.data.lastMessage.attachments[].size` | `object` | Yes | — | — |
| `result.data.lastMessage.attachments[].size.width` | `number` | Yes | — | — |
| `result.data.lastMessage.attachments[].size.height` | `number` | Yes | — | — |
| `result.data.lastMessage.attachments[].sticker` | `boolean` | Yes | — | — |
| `result.data.lastMessage.attachments[].gif` | `boolean` | Yes | — | — |
| `result.data.lastMessage.attachments[].duration` | `number` | No | — | — |
| `result.data.lastMessage.attachments[].voice_note` | `boolean` | Yes | — | — |
| `result.data.lastMessage.attachments[].file_name` | `string` | Yes | — | — |
| `result.data.lastMessage.attachments[].starts_at` | `number \| null` | Yes | — | — |
| `result.data.lastMessage.attachments[].expires_at` | `number \| null` | Yes | — | — |
| `result.data.lastMessage.attachments[].time_range` | `number \| null` | Yes | — | — |
| `result.data.lastMessage.attachments[].post` | `object` | No | — | — |
| `result.data.lastMessage.attachments[].post.url` | `string` | Yes | — | — |
| `result.data.lastMessage.attachments[].post.author` | `string` | No | — | — |
| `result.data.lastMessage.attachments[].post.author_id` | `string` | No | — | — |
| `result.data.lastMessage.attachments[].post.author_messaging_id` | `string` | No | — | — |

The table shows the first 50 fields. Use the live contract below for every field.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe unipile_get_chat --json`.

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Unipile provider guide](https://deepline.com/docs/providers/unipile/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.