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

# Attention: List Chats

> List Attention chats in a date range, with or without transcripts. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List Attention chats in a date range, with or without transcripts.

> [!NOTE]
>
> Tool ID: `attention_list_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(
  'attention_list_chats',
  {
    "filter": {
      "external_id": "external_123",
      "type": "chat",
      "title": "VP of Engineering"
    },
    "from_date_time": "2026-01-15T12:00:00Z",
    "to_date_time": "2026-01-15T12:00:00Z"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute attention_list_chats --input '{
  "filter": {
    "external_id": "external_123",
    "type": "chat",
    "title": "VP of Engineering"
  },
  "from_date_time": "2026-01-15T12:00:00Z",
  "to_date_time": "2026-01-15T12:00:00Z"
}' --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": {
    "data": [
      {
        "id": "id_123",
        "externalId": "external_123",
        "applicationName": "Example"
      }
    ],
    "meta": {
      "pageCount": 123,
      "totalRecords": 123,
      "pageNumber": 123
    }
  }
}
```

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

## Input reference

Returns a paginated list of chats with optional filters. Org-level API keys return all chats. user-level keys return only chats accessible to the user.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.filter` | `object` | No | — | Filter by external ID (exact match) |
| `payload.from_date_time` | `string` | No | — | Start of date range filter (ISO 8601 format) Format: `date-time`. |
| `payload.to_date_time` | `string` | No | — | End of date range filter (ISO 8601 format) Format: `date-time`. |
| `payload.exclude_transcript` | `boolean` | No | `false` | If true, omit transcript data from response to reduce payload size |
| `payload.page` | `integer` | No | `1` | Page number for pagination (starts from 1) Minimum: 1. |
| `payload.size` | `integer` | No | `10` | Number of items per page (min 1, max 50) Minimum: 1. Maximum: 50. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns a paginated list of chats with optional filters. Org-level API keys return all chats; user-level keys return only chats accessible to the user.",
    "properties": {
      "filter": {
        "type": "object",
        "description": "Filter by external ID (exact match)",
        "properties": {
          "external_id": {
            "type": "string",
            "description": "Filter by external ID (exact match)"
          },
          "type": {
            "type": "string",
            "description": "Filter by chat type (chat or email)",
            "enum": [
              "chat",
              "email"
            ]
          },
          "title": {
            "type": "string",
            "description": "Filter by title (case-insensitive partial match)"
          },
          "participant_name": {
            "type": "string",
            "description": "Filter by participant name (case-insensitive partial match)"
          },
          "scorecard_id": {
            "type": "array",
            "description": "Filter by scorecard UUID(s) — returns chats evaluated with any of the given scorecards",
            "items": {
              "type": "string"
            }
          },
          "user_id": {
            "type": "array",
            "description": "Filter by user UUID(s)",
            "items": {
              "type": "string"
            }
          },
          "team_id": {
            "type": "array",
            "description": "Filter by team UUID(s)",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [],
        "additionalProperties": false
      },
      "from_date_time": {
        "type": "string",
        "description": "Start of date range filter (ISO 8601 format)",
        "format": "date-time"
      },
      "to_date_time": {
        "type": "string",
        "description": "End of date range filter (ISO 8601 format)",
        "format": "date-time"
      },
      "exclude_transcript": {
        "type": "boolean",
        "description": "If true, omit transcript data from response to reduce payload size",
        "default": false
      },
      "page": {
        "type": "integer",
        "description": "Page number for pagination (starts from 1)",
        "default": 1,
        "minimum": 1
      },
      "size": {
        "type": "integer",
        "description": "Number of items per page (min 1, max 50)",
        "default": 10,
        "minimum": 1,
        "maximum": 50
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `array` | No | — | — |
| `result.data.data[].id` | `string` | No | — | Unique identifier of the chat |
| `result.data.data[].externalId` | `string` | No | — | External identifier from the source system |
| `result.data.data[].applicationName` | `string` | No | — | Name of the application that created the chat |
| `result.data.data[].title` | `string` | No | — | Title of the chat |
| `result.data.data[].type` | `"chat" \| "email"` | No | — | Type of chat (chat or email) Allowed: `chat`, `email`. |
| `result.data.data[].userId` | `string` | No | — | UUID of the user who owns the chat |
| `result.data.data[].teamId` | `string` | No | — | UUID of the team the chat belongs to |
| `result.data.data[].participants` | `array` | No | — | List of chat participants |
| `result.data.data[].participants[].externalId` | `string` | No | — | External identifier of the participant |
| `result.data.data[].participants[].name` | `string` | No | — | Display name of the participant |
| `result.data.data[].participants[].email` | `string` | No | — | Email address of the participant |
| `result.data.data[].participants[].participantType` | `"prospect" \| "user" \| "bot"` | No | — | Type of participant Allowed: `prospect`, `user`, `bot`. |
| `result.data.data[].participants[].userUuid` | `string` | No | — | UUID of the associated user (if applicable) |
| `result.data.data[].transcript` | `array` | No | — | Chat transcript entries (omitted when exclude\_transcript=true) |
| `result.data.data[].transcript[].sentence` | `string` | No | — | The text content of the transcript entry |
| `result.data.data[].transcript[].author` | `string` | No | — | Name of the author |
| `result.data.data[].transcript[].authorEmail` | `string` | No | — | Email address of the author |
| `result.data.data[].transcript[].datetime` | `string` | No | — | Timestamp of the transcript entry Format: `date-time`. |
| `result.data.data[].dateStart` | `string` | No | — | When the chat started Format: `date-time`. |
| `result.data.data[].createdAt` | `string` | No | — | When the chat record was created Format: `date-time`. |
| `result.data.meta` | `object` | No | — | — |
| `result.data.meta.pageCount` | `integer` | No | — | — |
| `result.data.meta.totalRecords` | `integer` | No | — | — |
| `result.data.meta.pageNumber` | `integer` | No | — | — |
| `result.data.meta.pageSize` | `integer` | No | — | — |
| `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": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Unique identifier of the chat"
                },
                "externalId": {
                  "type": "string",
                  "description": "External identifier from the source system"
                },
                "applicationName": {
                  "type": "string",
                  "description": "Name of the application that created the chat"
                },
                "title": {
                  "type": "string",
                  "description": "Title of the chat"
                },
                "type": {
                  "type": "string",
                  "description": "Type of chat (chat or email)",
                  "enum": [
                    "chat",
                    "email"
                  ]
                },
                "userId": {
                  "type": "string",
                  "description": "UUID of the user who owns the chat"
                },
                "teamId": {
                  "type": "string",
                  "description": "UUID of the team the chat belongs to"
                },
                "participants": {
                  "type": "array",
                  "description": "List of chat participants",
                  "items": {
                    "type": "object",
                    "properties": {
                      "externalId": {
                        "type": "string",
                        "description": "External identifier of the participant"
                      },
                      "name": {
                        "type": "string",
                        "description": "Display name of the participant"
                      },
                      "email": {
                        "type": "string",
                        "description": "Email address of the participant"
                      },
                      "participantType": {
                        "type": "string",
                        "description": "Type of participant",
                        "enum": [
                          "prospect",
                          "user",
                          "bot"
                        ]
                      },
                      "userUuid": {
                        "type": "string",
                        "description": "UUID of the associated user (if applicable)"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "transcript": {
                  "type": "array",
                  "description": "Chat transcript entries (omitted when exclude_transcript=true)",
                  "items": {
                    "type": "object",
                    "properties": {
                      "sentence": {
                        "type": "string",
                        "description": "The text content of the transcript entry"
                      },
                      "author": {
                        "type": "string",
                        "description": "Name of the author"
                      },
                      "authorEmail": {
                        "type": "string",
                        "description": "Email address of the author"
                      },
                      "datetime": {
                        "type": "string",
                        "description": "Timestamp of the transcript entry",
                        "format": "date-time"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "dateStart": {
                  "type": "string",
                  "description": "When the chat started",
                  "format": "date-time"
                },
                "createdAt": {
                  "type": "string",
                  "description": "When the chat record was created",
                  "format": "date-time"
                }
              },
              "additionalProperties": false
            }
          },
          "meta": {
            "type": "object",
            "properties": {
              "pageCount": {
                "type": "integer"
              },
              "totalRecords": {
                "type": "integer"
              },
              "pageNumber": {
                "type": "integer"
              },
              "pageSize": {
                "type": "integer"
              }
            },
            "additionalProperties": false
          }
        },
        "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

* [Attention provider guide](https://deepline.com/docs/providers/attention/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.