## List Split Jobs

`SplitListPageResponse Beta.Split.List(SplitListParams?parameters, CancellationTokencancellationToken = default)`

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

List document split jobs.

### Parameters

- `SplitListParams parameters`

  - `DateTimeOffset? createdAtOnOrAfter`

    Include items created at or after this timestamp (inclusive)

  - `DateTimeOffset? createdAtOnOrBefore`

    Include items created at or before this timestamp (inclusive)

  - `IReadOnlyList<string>? jobIds`

    Filter by specific job IDs

  - `string? organizationID`

  - `Long? pageSize`

  - `string? pageToken`

  - `string? projectID`

  - `Status? status`

    Filter by job status (pending, processing, completed, failed, cancelled)

    - `"cancelled"Cancelled`

    - `"completed"Completed`

    - `"failed"Failed`

    - `"pending"Pending`

    - `"processing"Processing`

### Returns

- `class SplitListPageResponse:`

  Beta paginated list of split jobs.

  - `required IReadOnlyList<SplitListResponse> Items`

    The list of items.

    - `required string ID`

      Unique identifier for the split job.

    - `required IReadOnlyList<SplitCategory> Categories`

      Categories used for splitting.

      - `required string Name`

        Name of the category.

      - `string? Description`

        Optional description of what content belongs in this category.

    - `required SplitDocumentInput DocumentInput`

      Document that was split.

      - `required string Type`

        Type of document input. Valid values are: file_id

      - `required string Value`

        Document identifier.

    - `required string ProjectID`

      Project ID this job belongs to.

    - `required string Status`

      Current status of the job. Valid values are: pending, processing, completed, failed, cancelled.

    - `required string UserID`

      User ID who created this job.

    - `string? ConfigurationID`

      Split configuration ID used for this job.

    - `DateTimeOffset? CreatedAt`

      Creation datetime

    - `string? ErrorMessage`

      Error message if the job failed.

    - `SplitResultResponse? Result`

      Result of a completed split job.

      - `required IReadOnlyList<SplitSegmentResponse> Segments`

        List of document segments.

        - `required string Category`

          Category name this split belongs to.

        - `required string ConfidenceCategory`

          Categorical confidence level. Valid values are: high, medium, low.

        - `required IReadOnlyList<Long> Pages`

          1-indexed page numbers in this split.

    - `DateTimeOffset? UpdatedAt`

      Update datetime

  - `string? NextPageToken`

    A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

  - `Long? TotalSize`

    The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

### Example

```csharp
SplitListParams parameters = new();

var page = await client.Beta.Split.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}
```

#### Response

```json
{
  "items": [
    {
      "id": "id",
      "categories": [
        {
          "name": "x",
          "description": "x"
        }
      ],
      "document_input": {
        "type": "type",
        "value": "value"
      },
      "project_id": "project_id",
      "status": "status",
      "user_id": "user_id",
      "configuration_id": "configuration_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "error_message": "error_message",
      "result": {
        "segments": [
          {
            "category": "category",
            "confidence_category": "confidence_category",
            "pages": [
              0
            ]
          }
        ]
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
```