## List Spreadsheet Jobs

`SheetListPage beta().sheets().list(SheetListParamsparams = SheetListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

**get** `/api/v1/beta/sheets/jobs`

List spreadsheet parsing jobs. Experimental: not production-ready and subject to change.

### Parameters

- `SheetListParams params`

  - `Optional<String> configurationId`

    Filter by saved configuration ID

  - `Optional<LocalDateTime> createdAtOnOrAfter`

    Include items created at or after this timestamp (inclusive)

  - `Optional<LocalDateTime> createdAtOnOrBefore`

    Include items created at or before this timestamp (inclusive)

  - `Optional<Boolean> includeResults`

  - `Optional<List<String>> jobIds`

    Filter by specific job IDs

  - `Optional<String> organizationId`

  - `Optional<Long> pageSize`

  - `Optional<String> pageToken`

  - `Optional<String> projectId`

  - `Optional<Status> status`

    Filter by job status

    - `PENDING("PENDING")`

    - `SUCCESS("SUCCESS")`

    - `ERROR("ERROR")`

    - `PARTIAL_SUCCESS("PARTIAL_SUCCESS")`

    - `CANCELLED("CANCELLED")`

### Returns

- `class SheetsJob:`

  A spreadsheet parsing job.

  - `String id`

    The ID of the job

  - `SheetsParsingConfig configuration`

    Configuration applied to the parsing job (inline or resolved from a saved preset).

    - `Optional<String> extractionRange`

      A1 notation of the range to extract a single region from. If None, the entire sheet is used.

    - `Optional<Boolean> flattenHierarchicalTables`

      Return a flattened dataframe when a detected table is recognized as hierarchical.

    - `Optional<Boolean> generateAdditionalMetadata`

      Whether to generate additional metadata (title, description) for each extracted region.

    - `Optional<Boolean> includeHiddenCells`

      Whether to include hidden cells when extracting regions from the spreadsheet.

    - `Optional<List<String>> sheetNames`

      The names of the sheets to extract regions from. If empty, all sheets will be processed.

    - `Optional<String> specialization`

      Optional specialization mode for domain-specific extraction. Supported values: 'financial-standard', 'financial-enhanced', 'financial-precise'. Default None uses the general-purpose pipeline.

    - `Optional<TableMergeSensitivity> tableMergeSensitivity`

      Influences how likely similar-looking regions are merged into a single table. Useful for spreadsheets that either have sparse tables (strong merging) or many distinct tables close together (weak merging).

      - `STRONG("strong")`

      - `WEAK("weak")`

    - `Optional<Boolean> useExperimentalProcessing`

      Enables experimental processing. Accuracy may be impacted.

  - `String createdAt`

    When the job was created

  - `Optional<String> fileId`

    The ID of the input file

  - `String projectId`

    The ID of the project

  - `Status status`

    The status of the parsing job

    - `PENDING("PENDING")`

    - `SUCCESS("SUCCESS")`

    - `ERROR("ERROR")`

    - `PARTIAL_SUCCESS("PARTIAL_SUCCESS")`

    - `CANCELLED("CANCELLED")`

  - `String updatedAt`

    When the job was last updated

  - `String userId`

    The ID of the user

  - `Optional<SheetsParsingConfig> config`

    Configuration for spreadsheet parsing and region extraction

  - `Optional<String> configurationId`

    The saved product configuration ID used at create time, if any.

  - `Optional<List<String>> errors`

    Any errors encountered

  - `Optional<File> file`

    Schema for a file.

    - `String id`

      Unique identifier

    - `String name`

    - `String projectId`

      The ID of the project that the file belongs to

    - `Optional<LocalDateTime> createdAt`

      Creation datetime

    - `Optional<String> dataSourceId`

      The ID of the data source that the file belongs to

    - `Optional<LocalDateTime> expiresAt`

      The expiration date for the file. Files past this date can be deleted.

    - `Optional<String> externalFileId`

      The ID of the file in the external system

    - `Optional<Long> fileSize`

      Size of the file in bytes

    - `Optional<String> fileType`

      File type (e.g. pdf, docx, etc.)

    - `Optional<LocalDateTime> lastModifiedAt`

      The last modified time of the file

    - `Optional<PermissionInfo> permissionInfo`

      Permission information for the file

      - `class UnionMember0:`

      - `List<JsonValue>`

      - `String`

      - `double`

      - `boolean`

    - `Optional<String> purpose`

      The intended purpose of the file (e.g., 'user_data', 'parse', 'extract', 'split', 'classify')

    - `Optional<ResourceInfo> resourceInfo`

      Resource information for the file

      - `class UnionMember0:`

      - `List<JsonValue>`

      - `String`

      - `double`

      - `boolean`

    - `Optional<LocalDateTime> updatedAt`

      Update datetime

  - `Optional<MetadataStateTransitions> metadataStateTransitions`

    Per-status entry timestamps. Returned only when requested via `?expand=metadata_state_transitions`.

  - `Optional<Parameters> parameters`

    Job-time parameters such as webhook configurations.

    - `Optional<List<WebhookConfiguration>> webhookConfigurations`

      Webhook configurations for job status notifications.

      - `Optional<List<WebhookEvent>> webhookEvents`

        Events to subscribe to (e.g. 'parse.success', 'extract.error'). If null, all events are delivered.

        - `EXTRACT_PENDING("extract.pending")`

        - `EXTRACT_SUCCESS("extract.success")`

        - `EXTRACT_ERROR("extract.error")`

        - `EXTRACT_PARTIAL_SUCCESS("extract.partial_success")`

        - `EXTRACT_CANCELLED("extract.cancelled")`

        - `PARSE_PENDING("parse.pending")`

        - `PARSE_RUNNING("parse.running")`

        - `PARSE_SUCCESS("parse.success")`

        - `PARSE_ERROR("parse.error")`

        - `PARSE_PARTIAL_SUCCESS("parse.partial_success")`

        - `PARSE_CANCELLED("parse.cancelled")`

        - `CLASSIFY_PENDING("classify.pending")`

        - `CLASSIFY_RUNNING("classify.running")`

        - `CLASSIFY_SUCCESS("classify.success")`

        - `CLASSIFY_ERROR("classify.error")`

        - `CLASSIFY_PARTIAL_SUCCESS("classify.partial_success")`

        - `CLASSIFY_CANCELLED("classify.cancelled")`

        - `SHEETS_PENDING("sheets.pending")`

        - `SHEETS_SUCCESS("sheets.success")`

        - `SHEETS_ERROR("sheets.error")`

        - `SHEETS_PARTIAL_SUCCESS("sheets.partial_success")`

        - `SHEETS_CANCELLED("sheets.cancelled")`

        - `UNMAPPED_EVENT("unmapped_event")`

      - `Optional<WebhookHeaders> webhookHeaders`

        Custom HTTP headers sent with each webhook request (e.g. auth tokens)

      - `Optional<String> webhookOutputFormat`

        Response format sent to the webhook: 'string' (default) or 'json'

      - `Optional<String> webhookUrl`

        URL to receive webhook POST notifications

  - `Optional<List<Region>> regions`

    All extracted regions (populated when job is complete)

    - `String location`

      Location of the region in the spreadsheet

    - `String regionType`

      Type of the extracted region

    - `String sheetName`

      Worksheet name where region was found

    - `Optional<String> description`

      Generated description for the region

    - `Optional<String> regionId`

      Unique identifier for this region within the file

    - `Optional<String> title`

      Generated title for the region

  - `Optional<Boolean> success`

    Whether the job completed successfully

  - `Optional<List<WorksheetMetadata>> worksheetMetadata`

    Metadata for each processed worksheet (populated when job is complete)

    - `String sheetName`

      Name of the worksheet

    - `Optional<String> description`

      Generated description of the worksheet

    - `Optional<String> title`

      Generated title for the worksheet

### Example

```java
package com.llamacloud_prod.api.example;

import com.llamacloud_prod.api.client.LlamaCloudClient;
import com.llamacloud_prod.api.client.okhttp.LlamaCloudOkHttpClient;
import com.llamacloud_prod.api.models.beta.sheets.SheetListPage;
import com.llamacloud_prod.api.models.beta.sheets.SheetListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        SheetListPage page = client.beta().sheets().list();
    }
}
```

#### Response

```json
{
  "items": [
    {
      "id": "id",
      "configuration": {
        "extraction_range": "extraction_range",
        "flatten_hierarchical_tables": true,
        "generate_additional_metadata": true,
        "include_hidden_cells": true,
        "sheet_names": [
          "string"
        ],
        "specialization": "specialization",
        "table_merge_sensitivity": "strong",
        "use_experimental_processing": true
      },
      "created_at": "created_at",
      "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "status": "PENDING",
      "updated_at": "updated_at",
      "user_id": "user_id",
      "config": {
        "extraction_range": "extraction_range",
        "flatten_hierarchical_tables": true,
        "generate_additional_metadata": true,
        "include_hidden_cells": true,
        "sheet_names": [
          "string"
        ],
        "specialization": "specialization",
        "table_merge_sensitivity": "strong",
        "use_experimental_processing": true
      },
      "configuration_id": "configuration_id",
      "errors": [
        "string"
      ],
      "file": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "name": "x",
        "project_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "created_at": "2019-12-27T18:11:19.117Z",
        "data_source_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "expires_at": "2019-12-27T18:11:19.117Z",
        "external_file_id": "external_file_id",
        "file_size": 0,
        "file_type": "x",
        "last_modified_at": "2019-12-27T18:11:19.117Z",
        "permission_info": {
          "foo": {
            "foo": "bar"
          }
        },
        "purpose": "purpose",
        "resource_info": {
          "foo": {
            "foo": "bar"
          }
        },
        "updated_at": "2019-12-27T18:11:19.117Z"
      },
      "metadata_state_transitions": {
        "foo": "bar"
      },
      "parameters": {
        "webhook_configurations": [
          {
            "webhook_events": [
              "parse.success",
              "parse.error"
            ],
            "webhook_headers": {
              "Authorization": "Bearer sk-..."
            },
            "webhook_output_format": "json",
            "webhook_url": "https://example.com/webhooks/llamacloud"
          }
        ]
      },
      "regions": [
        {
          "location": "location",
          "region_type": "region_type",
          "sheet_name": "sheet_name",
          "description": "description",
          "region_id": "region_id",
          "title": "title"
        }
      ],
      "success": true,
      "worksheet_metadata": [
        {
          "sheet_name": "sheet_name",
          "description": "description",
          "title": "title"
        }
      ]
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
```