## List structured sheets

`client.StructuredSheets.List(ctx, query) (*CursorIDPage[StructuredSheetResponse], error)`

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

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

### Parameters

- `query StructuredSheetListParams`

  - `After param.Field[string]`

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

  - `Limit param.Field[int64]`

    Maximum number of results to return per page.

### Returns

- `type StructuredSheetResponse struct{…}`

  Response representing a structured sheet conversion job.

  This is returned from POST (create), GET (retrieve), and list endpoints.

  - `ID string`

    The unique identifier for this structured sheet conversion.

  - `CreatedAt Time`

    The timestamp when the conversion was started.

  - `FileID string`

    The unique identifier for the source file.

  - `Object StructuredSheet`

    The object type, which is always 'structured_sheet'.

    - `const StructuredSheetStructuredSheet StructuredSheet = "structured_sheet"`

  - `Status StructuredSheetResponseStatus`

    The current processing status.

    - `const StructuredSheetResponseStatusQueued StructuredSheetResponseStatus = "queued"`

    - `const StructuredSheetResponseStatusInProgress StructuredSheetResponseStatus = "in_progress"`

    - `const StructuredSheetResponseStatusCompleted StructuredSheetResponseStatus = "completed"`

    - `const StructuredSheetResponseStatusFailed StructuredSheetResponseStatus = "failed"`

    - `const StructuredSheetResponseStatusCancelled StructuredSheetResponseStatus = "cancelled"`

  - `UpdatedAt Time`

    The timestamp when the conversion was last updated.

  - `LastError StructuredSheetResponseLastError`

    Error information when processing fails.

    - `Code string`

      A machine-readable error code.

    - `Message string`

      A human-readable description of the error.

  - `SheetNames []string`

    List of sheet names included in this conversion.

  - `TableCount int64`

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

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/deeptable-com/deeptable-go"
  "github.com/deeptable-com/deeptable-go/option"
)

func main() {
  client := deeptable.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.StructuredSheets.List(context.TODO(), deeptable.StructuredSheetListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
```

#### 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"
}
```