---
title: "List Scans"
method: GET
path: "/chat/workspace-scans"
tags: ["workspace scans"]
---

# List Scans

`GET /chat/workspace-scans`

## Request

- Base URL: `https://api.traversal.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.traversal.com/chat/workspace-scans`
- Auth: none declared

## Query parameters

- `integration_id` string, uuid, required: Chat integration to list scans for.

## Response `200`

Successful Response

- ListWorkspaceScansResponse
  - `scans` ChatWorkspaceScan[], required
    - `id` string, uuid, required
    - `organization_id` string, uuid, required
    - `integration_id` string, uuid, required
    - `started_by_user_id` string, uuid, required
    - `status` 'pending' | 'running' | 'partial' | 'completed' | 'failed', required
    - `stage` 'resolving_integration' | 'preparing_inventory' | 'selecting_candidates' | 'analyzing' | 'finalizing' | 'ready', required
    - `deadline_at` string, date-time, required
    - `inventory_refreshed_at` string, date-time, nullable, required
    - `progress` WorkspaceScanProgress, required
      - `schema_version` integer, required
      - `channels_discovered` integer, required
      - `channels_eligible` integer, required
      - `channels_enriched` integer, required
    - `error_code` string, nullable, required
    - `error_message` string, nullable, required
    - `revision` integer, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `completed_at` string, date-time, nullable, required

## Other responses

- `422`: Validation Error

## Changes

> 66 revisions in range; 9 not diffed.

- **2026-08-28** `6bbc7dd4088c`: 1 breaking
  - the `schema_version` response property const value `1` was removed for the status `200`
- **2026-08-24** `ca8396674832`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/traversal/apis/traversal-api/changes/chat/workspace-scans/get.md)

---

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