> ## 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: List Attendee Chats

> List the 1-to-1 chats with one attendee. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the 1-to-1 chats with one attendee.

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

## 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_list_attendee_chats',
  {
    "attendee_id": "attendee_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute unipile_list_attendee_chats --input '{
  "attendee_id": "attendee_123"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "object": "ChatList",
    "items": [
      {
        "object": "Chat",
        "id": "id_123",
        "account_id": "123456789",
        "account_type": "WHATSAPP",
        "provider_id": "provider_123",
        "name": "Example",
        "type": 0,
        "timestamp": "example",
        "unread_count": 123,
        "archived": 0,
        "muted_until": -1,
        "read_only": 0,
        "pinned": 0
      }
    ],
    "cursor": "cursor_123"
  }
}
```

Use `deepline describe unipile_list_attendee_chats --json` for the latest machine-readable contract.

## Input reference

Returns a list of chats where a given attendee is involved.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.cursor` | `string` | No | — | A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. Minimum length: 1. |
| `payload.before` | `string` | No | — | A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ). Pattern: `^[1-2]\d&#123;3&#125;-[0-1]\d-[0-3]\dT\d&#123;2&#125;:\d&#123;2&#125;:\d&#123;2&#125;.\d&#123;3&#125;Z$`. |
| `payload.after` | `string` | No | — | A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ). Pattern: `^[1-2]\d&#123;3&#125;-[0-1]\d-[0-3]\dT\d&#123;2&#125;:\d&#123;2&#125;:\d&#123;2&#125;.\d&#123;3&#125;Z$`. |
| `payload.limit` | `integer` | No | — | A limit for the number of items returned in the response. The value can be set between 1 and 250. Minimum: 1. Maximum: 250. |
| `payload.account_id` | `string` | No | — | A filter to target items related to a certain account. Can be a comma-separated list of ids. Minimum length: 1. |
| `payload.attendee_id` | `string` | Yes | — | The Unipile ID OR provider\_id of the attendee. Can be a comma-separated list of multiple ids. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns a list of chats where a given attendee is involved.",
    "properties": {
      "cursor": {
        "type": "string",
        "description": "A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.",
        "minLength": 1
      },
      "before": {
        "type": "string",
        "description": "A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).",
        "pattern": "^[1-2]\\d{3}-[0-1]\\d-[0-3]\\dT\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$"
      },
      "after": {
        "type": "string",
        "description": "A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).",
        "pattern": "^[1-2]\\d{3}-[0-1]\\d-[0-3]\\dT\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$"
      },
      "limit": {
        "type": "integer",
        "description": "A limit for the number of items returned in the response. The value can be set between 1 and 250.",
        "minimum": 1,
        "maximum": 250
      },
      "account_id": {
        "type": "string",
        "description": "A filter to target items related to a certain account. Can be a comma-separated list of ids.",
        "minLength": 1
      },
      "attendee_id": {
        "type": "string",
        "description": "The Unipile ID OR provider_id of the attendee. Can be a comma-separated list of multiple ids."
      }
    },
    "required": [
      "attendee_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.object` | `"ChatList"` | Yes | — | Allowed: `ChatList`. |
| `result.data.items` | `array` | Yes | — | — |
| `result.data.items[].object` | `"Chat"` | Yes | — | Allowed: `Chat`. |
| `result.data.items[].id` | `string` | Yes | — | A unique identifier. Minimum length: 1. |
| `result.data.items[].account_id` | `string` | Yes | — | A unique identifier. Minimum length: 1. |
| `result.data.items[].account_type` | `"WHATSAPP" \| "LINKEDIN" \| "SLACK" \| "TWITTER" \| "MESSENGER" \| "INSTAGRAM" \| "TELEGRAM"` | Yes | — | — |
| `result.data.items[].provider_id` | `string` | Yes | — | — |
| `result.data.items[].attendee_provider_id` | `string` | No | — | — |
| `result.data.items[].name` | `string \| null` | Yes | — | — |
| `result.data.items[].type` | `0 \| 1 \| 2` | Yes | — | — |
| `result.data.items[].timestamp` | `string \| null` | Yes | — | — |
| `result.data.items[].unread_count` | `number` | Yes | — | — |
| `result.data.items[].archived` | `0 \| 1` | Yes | — | — |
| `result.data.items[].muted_until` | `-1 \| string \| null` | Yes | — | — |
| `result.data.items[].read_only` | `0 \| 1 \| 2` | Yes | — | — |
| `result.data.items[].disabledFeatures` | `array` | No | — | — |
| `result.data.items[].subject` | `string` | No | — | — |
| `result.data.items[].organization_id` | `string` | No | — | Linkedin specific ID for organization mailboxes. |
| `result.data.items[].mailbox_id` | `string` | No | — | Linkedin specific ID for organization mailboxes. |
| `result.data.items[].content_type` | `"inmail" \| "sponsored" \| "linkedin_offer"` | No | — | — |
| `result.data.items[].folder` | `array` | No | — | — |
| `result.data.items[].pinned` | `0 \| 1` | Yes | — | — |
| `result.data.cursor` | `unknown \| null` | Yes | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "object": {
            "type": "string",
            "enum": [
              "ChatList"
            ]
          },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "object": {
                  "type": "string",
                  "enum": [
                    "Chat"
                  ]
                },
                "id": {
                  "type": "string",
                  "description": "A unique identifier.",
                  "minLength": 1
                },
                "account_id": {
                  "type": "string",
                  "description": "A unique identifier.",
                  "minLength": 1
                },
                "account_type": {
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "WHATSAPP"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "LINKEDIN"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "SLACK"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "TWITTER"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "MESSENGER"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "INSTAGRAM"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "TELEGRAM"
                      ]
                    }
                  ]
                },
                "provider_id": {
                  "type": "string"
                },
                "attendee_provider_id": {
                  "type": "string"
                },
                "name": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "type": {
                  "anyOf": [
                    {
                      "type": "number",
                      "enum": [
                        0
                      ]
                    },
                    {
                      "type": "number",
                      "enum": [
                        1
                      ]
                    },
                    {
                      "type": "number",
                      "enum": [
                        2
                      ]
                    }
                  ]
                },
                "timestamp": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "unread_count": {
                  "type": "number"
                },
                "archived": {
                  "anyOf": [
                    {
                      "type": "number",
                      "enum": [
                        0
                      ]
                    },
                    {
                      "type": "number",
                      "enum": [
                        1
                      ]
                    }
                  ]
                },
                "muted_until": {
                  "anyOf": [
                    {
                      "type": "number",
                      "enum": [
                        -1
                      ]
                    },
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "read_only": {
                  "anyOf": [
                    {
                      "type": "number",
                      "enum": [
                        0
                      ]
                    },
                    {
                      "type": "number",
                      "enum": [
                        1
                      ]
                    },
                    {
                      "type": "number",
                      "enum": [
                        2
                      ]
                    }
                  ]
                },
                "disabledFeatures": {
                  "type": "array",
                  "items": {
                    "anyOf": [
                      {
                        "type": "string",
                        "enum": [
                          "reactions"
                        ]
                      },
                      {
                        "type": "string",
                        "enum": [
                          "reply"
                        ]
                      }
                    ]
                  }
                },
                "subject": {
                  "type": "string"
                },
                "organization_id": {
                  "type": "string",
                  "description": "Linkedin specific ID for organization mailboxes."
                },
                "mailbox_id": {
                  "type": "string",
                  "description": "Linkedin specific ID for organization mailboxes."
                },
                "content_type": {
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "inmail"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "sponsored"
                      ]
                    },
                    {
                      "type": "string",
                      "enum": [
                        "linkedin_offer"
                      ]
                    }
                  ]
                },
                "folder": {
                  "type": "array",
                  "items": {
                    "anyOf": [
                      {
                        "type": "string",
                        "enum": [
                          "INBOX"
                        ]
                      },
                      {
                        "type": "string",
                        "enum": [
                          "INBOX_LINKEDIN_CLASSIC"
                        ]
                      },
                      {
                        "type": "string",
                        "enum": [
                          "INBOX_LINKEDIN_RECRUITER"
                        ]
                      },
                      {
                        "type": "string",
                        "enum": [
                          "INBOX_LINKEDIN_SALES_NAVIGATOR"
                        ]
                      },
                      {
                        "type": "string",
                        "enum": [
                          "INBOX_LINKEDIN_ORGANIZATION"
                        ]
                      },
                      {
                        "type": "string",
                        "enum": [
                          "INBOX_INSTAGRAM_GENERAL"
                        ]
                      },
                      {
                        "type": "string",
                        "enum": [
                          "PENDING"
                        ]
                      },
                      {
                        "type": "string",
                        "enum": [
                          "OTHER"
                        ]
                      },
                      {
                        "type": "string",
                        "enum": [
                          "SPAM"
                        ]
                      },
                      {
                        "type": "string",
                        "enum": [
                          "ARCHIVED"
                        ]
                      },
                      {
                        "type": "string",
                        "enum": [
                          "HIDDEN"
                        ]
                      },
                      {
                        "type": "string",
                        "enum": [
                          "UNKNOWN"
                        ]
                      },
                      {
                        "type": "string"
                      }
                    ]
                  }
                },
                "pinned": {
                  "anyOf": [
                    {
                      "type": "number",
                      "enum": [
                        0
                      ]
                    },
                    {
                      "type": "number",
                      "enum": [
                        1
                      ]
                    }
                  ]
                }
              },
              "required": [
                "object",
                "id",
                "account_id",
                "account_type",
                "provider_id",
                "name",
                "type",
                "timestamp",
                "unread_count",
                "archived",
                "muted_until",
                "read_only",
                "pinned"
              ],
              "additionalProperties": false
            }
          },
          "cursor": {
            "anyOf": [
              {},
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "object",
          "items",
          "cursor"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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.