## List structured sheets

`$ deeptable structured-sheets list`

**get** `/v1/structured-sheets`

List all structured sheets conversions for the authenticated user. Results are paginated using cursor-based pagination.

### Parameters

- `--after: optional string`

  A cursor for pagination. Use the `last_id` from a previous response to fetch the next page of results.

- `--limit: optional number`

  Maximum number of results to return per page.

### Returns

- `StructuredSheetListResponse: object { data, has_more, object, 2 more }`

  Paginated response for listing structured sheet conversions.

  Uses cursor-based pagination for efficient iteration through results.

  - `data: array of StructuredSheetResponse`

    List of structured sheet conversions.

    - `id: string`

      The unique identifier for this structured sheet conversion.

    - `created_at: string`

      The timestamp when the conversion was started.

    - `file_id: string`

      The unique identifier for the source file.

    - `object: "structured_sheet"`

      The object type, which is always 'structured_sheet'.

      - `"structured_sheet"`

    - `status: "queued" or "in_progress" or "completed" or 2 more`

      The current processing status.

      - `"queued"`

      - `"in_progress"`

      - `"completed"`

      - `"failed"`

      - `"cancelled"`

    - `updated_at: string`

      The timestamp when the conversion was last updated.

    - `last_error: optional object { code, message }`

      Error information when processing fails.

      - `code: string`

        A machine-readable error code.

      - `message: string`

        A human-readable description of the error.

    - `sheet_names: optional array of string`

      List of sheet names included in this conversion.

    - `table_count: optional number`

      Number of tables extracted from the workbook. Only present when status is 'completed'.

  - `has_more: boolean`

    Whether there are more results available after this page.

  - `object: "list"`

    The object type, which is always 'list'.

    - `"list"`

  - `first_id: optional string`

    Unique identifier for a structured sheet conversion.

  - `last_id: optional string`

    Unique identifier for a structured sheet conversion.

### Example

```cli
deeptable structured-sheets list \
  --api-key 'My API Key'
```

#### Response

```json
{
  "data": [
    {
      "id": "ss_01kfxgjd94fn9stqm42nejb627",
      "created_at": "2024-01-15T10:30:00Z",
      "file_id": "file_01kfxgjd94fn9stqm414vjb0s8",
      "object": "structured_sheet",
      "status": "completed",
      "updated_at": "2024-01-15T10:35:00Z",
      "last_error": {
        "code": "invalid_file_format",
        "message": "The uploaded file is not a valid Excel spreadsheet."
      },
      "sheet_names": [
        "Sheet1",
        "Financials"
      ],
      "table_count": 6
    }
  ],
  "has_more": false,
  "object": "list",
  "first_id": "ss_01kfxgjd94fn9stqm42nejb627",
  "last_id": "ss_01kfxgjd94fn9stqm42nejb627"
}
```