> ## Documentation Index
> Fetch the complete documentation index at: https://docs.retab.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Parses

> List parses.

Returns a paginated list of parses for the authenticated environment, newest first by
default. Filter by `filename` prefix (case-insensitive) and by a `created_at` window
using `from_date`/`to_date` (`YYYY-MM-DD`). Page through results with `before`/`after`,
`limit`, and `order`.

List persisted parses for your organization, with id-based pagination and optional filename / date filtering.

<RequestExample>
  ```python Python theme={null}
  from datetime import datetime
  from retab import Retab

  client = Retab()

  # List recent parses
  parses = client.parses.list(limit=20, order="desc")
  for parse in parses.data:
      print(f"{parse.id}: {parse.file.filename}")

  # Filter by date range
  parses = client.parses.list(
      from_date=datetime(2024, 1, 1),
      to_date=datetime(2024, 12, 31),
      limit=50,
  )
  ```

  ```typescript TypeScript theme={null}
  import { Retab } from "@retab/node";

  const client = new Retab({ apiKey: process.env.RETAB_API_KEY });

  // List recent parses
  const parses = await client.parses.list({ limit: 20, order: "desc" });
  for (const parse of parses.data) {
    console.log(`${parse.id}: ${parse.file.filename}`);
  }

  // Filter by date range
  const ranged = await client.parses.list({
    fromDate: new Date("2024-01-01").toISOString(),
    toDate: new Date("2024-12-31").toISOString(),
    limit: 50,
  });
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"log"
  	"time"

  	retab "github.com/retab-dev/retab/clients/go"
  )

  func ptr[T any](v T) *T { return &v }

  func main() {
  	ctx := context.Background()

  	client, err := retab.NewClient("")
  	if err != nil {
  		log.Fatal(err)
  	}

  	// List recent parses
  	parses, err := client.Parses.List(ctx, &retab.ParsesListParams{
  		PaginationParams: retab.PaginationParams{Limit: ptr(20), Order: ptr("desc")},
  	})
  	if err != nil {
  		log.Fatal(err)
  	}
  	for _, parse := range parses.Data {
  		fmt.Printf("%s: %s\n", parse.ID, parse.File.Filename)
  	}

  	// Filter by date range
  	from := time.Date(2024, 1, 1, 0, 0, 0, 0, time.UTC)
  	to := time.Date(2024, 12, 31, 0, 0, 0, 0, time.UTC)
  	ranged, err := client.Parses.List(ctx, &retab.ParsesListParams{
  		PaginationParams: retab.PaginationParams{
  			Limit: ptr(50),
  		},
  		FromDate: ptr(from.Format("2006-01-02")),
  		ToDate:   ptr(to.Format("2006-01-02")),
  	})
  	if err != nil {
  		log.Fatal(err)
  	}
  	fmt.Println(ranged)
  }
  ```

  ```ruby Ruby theme={null}
  require 'retab'
  require 'date'

  client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])

  # List recent parses
  parses = client.parses.list(limit: 20, order: 'desc')
  parses.data.each do |parse|
    puts "#{parse.id}: #{parse.file.filename}"
  end

  # Filter by date range
  parses = client.parses.list(
    from_date: DateTime.new(2024, 1, 1),
    to_date: DateTime.new(2024, 12, 31),
    limit: 50,
  )
  ```

  ```rust Rust theme={null}
  use retab::enums::ParsesOrder;
  use retab::resources::parses::ListParams;
  use retab::Retab;

  #[tokio::main]
  async fn main() -> Result<(), Box<dyn std::error::Error>> {
      let client = Retab::new(std::env::var("RETAB_API_KEY")?);

      // List recent parses
      let parses = client
          .parses()
          .list(ListParams {
              limit: Some(20),
              order: Some(ParsesOrder::Desc),
              ..Default::default()
          })
          .await?;
      for parse in &parses.data {
          println!("{}: {}", parse.id, parse.file.filename);
      }

      // Filter by date range
      let _ranged = client
          .parses()
          .list(ListParams {
              from_date: Some("2024-01-01".into()),
              to_date: Some("2024-12-31".into()),
              limit: Some(50),
              ..Default::default()
          })
          .await?;
      Ok(())
  }
  ```

  ```php PHP theme={null}
  <?php
  require 'vendor/autoload.php';

  use Retab\Client;

  $client = new Client(apiKey: getenv('RETAB_API_KEY'));

  $result = $client->parses()->list();
  print_r($result);
  ```

  ```csharp C# theme={null}
  using Retab;
  using RetabClient = Retab.Retab;

  var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
  var client = new RetabClient(apiKey);

  var result = await client.Parses.ListAsync(new ParsesListOptions());
  Console.WriteLine(result);
  ```

  ```java Java theme={null}
  import com.retab.RetabClient;

  public final class Example {
    public static void main(String[] args) throws Exception {
      RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));

      var result = client.parses().list(null, null, 10L, null, "invoice.pdf", null, null);
      System.out.println(result);
    }
  }
  ```

  ```curl cURL theme={null}
  # List recent parses
  curl -X GET \
    'https://api.retab.com/v1/parses?limit=20&order=desc' \
    -H "Authorization: Bearer $RETAB_API_KEY"

  # Filter by filename prefix and date range
  curl -X GET \
    'https://api.retab.com/v1/parses?filename=invoice&from_date=2024-01-01&to_date=2024-12-31&limit=50' \
    -H "Authorization: Bearer $RETAB_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "data": [
      {
        "id": "parse_01G34H8J2K",
        "file": {
          "id": "file_6dd6eb00688ad8d1",
          "filename": "invoice.pdf",
          "mime_type": "application/pdf"
        },
        "model": "retab-small",
        "table_parsing_format": "markdown",
        "output": {
          "pages": ["Page 1 text...", "Page 2 text..."],
          "text": "Page 1 text...\n\nPage 2 text..."
        },
        "usage": {
          "page_count": 2,
          "credits": 1.0
        },
        "created_at": "2024-03-15T10:30:00Z"
      }
    ],
    "list_metadata": {
      "before": null,
      "after": "parse_01G34H8J2K",
      "total_count": 42
    }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /v1/parses
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://api.retab.com
security: []
paths:
  /v1/parses:
    get:
      tags:
        - Parses
      summary: List Parses
      description: >-
        List parses.


        Returns a paginated list of parses for the authenticated environment,
        newest first by

        default. Filter by `filename` prefix (case-insensitive) and by a
        `created_at` window

        using `from_date`/`to_date` (`YYYY-MM-DD`). Page through results with
        `before`/`after`,

        `limit`, and `order`.
      operationId: list_parses
      parameters:
        - in: query
          name: before
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Before
          required: false
        - in: query
          name: after
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: After
          required: false
        - in: query
          name: limit
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 10
            title: Limit
          required: false
        - in: query
          name: order
          schema:
            enum:
              - asc
              - desc
            type: string
            default: desc
            title: Order
          required: false
        - in: query
          name: filename
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Filename
          required: false
        - in: query
          name: from_date
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: From Date
          required: false
        - in: query
          name: to_date
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: To Date
          required: false
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParseList'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    ParseList:
      description: >-
        A page of `Parse` resources. `data` holds the items and `list_metadata`
        carries the `before`/`after` cursors; pass `after` to fetch the next
        page.
      properties:
        data:
          items:
            $ref: '#/components/schemas/Parse'
          type: array
          title: Data
        list_metadata:
          $ref: '#/components/schemas/ListMetadata'
      type: object
      required:
        - data
        - list_metadata
      title: ParseList
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
          default: []
      type: object
      title: HTTPValidationError
    Parse:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the parse
        file:
          $ref: '#/components/schemas/FileRef'
          description: Information about the parsed file
        model:
          type: string
          title: Model
          description: Model used for parsing
        table_parsing_format:
          type: string
          enum:
            - markdown
            - yaml
            - html
            - json
          title: Table Parsing Format
          description: Format used to render tables extracted from the document
        instructions:
          anyOf:
            - type: string
            - type: 'null'
          title: Instructions
          description: Free-form instructions supplied with the parse request.
        output:
          $ref: '#/components/schemas/ParseOutput'
          description: The parsed document content
        status:
          type: string
          enum:
            - pending
            - queued
            - in_progress
            - completed
            - failed
            - cancelled
          title: Status
          description: >-
            Lifecycle status. The synchronous path returns 'completed'.
            Background runs progress pending -> queued -> in_progress ->
            completed | failed | cancelled.
          default: pending
        error:
          anyOf:
            - $ref: '#/components/schemas/PrimitiveError'
            - type: 'null'
          description: >-
            Error details when a background run fails; null otherwise. Always
            present so consumers can read it without an existence check.
        usage:
          anyOf:
            - $ref: '#/components/schemas/RetabUsage'
            - type: 'null'
          description: Usage information for the parse operation
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
      type: object
      required:
        - file
        - id
        - model
        - output
        - table_parsing_format
      title: Parse
      description: >-
        A parse result: the per-page and full-document text extracted from a
        document.
    ListMetadata:
      properties:
        before:
          anyOf:
            - type: string
            - type: 'null'
          title: Before
        after:
          anyOf:
            - type: string
            - type: 'null'
          title: After
      type: object
      required:
        - after
        - before
      title: ListMetadata
      description: Boundary resource IDs for page navigation.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
          default: null
        ctx:
          type: object
          title: Context
          default: {}
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    FileRef:
      properties:
        id:
          type: string
          title: Id
          description: ID of the file
        filename:
          type: string
          title: Filename
          description: Filename of the file
        mime_type:
          type: string
          title: Mime Type
          description: MIME type of the file
      type: object
      required:
        - filename
        - id
        - mime_type
      title: FileRef
      description: Public/shared file reference used across SDK and customer-facing APIs.
    ParseOutput:
      properties:
        pages:
          items:
            type: string
          type: array
          title: Pages
          description: Text content of each page (1-indexed order)
        text:
          type: string
          title: Text
          description: Concatenated text content of the full document
      type: object
      required:
        - pages
        - text
      title: ParseOutput
    PrimitiveError:
      properties:
        code:
          type: string
          title: Code
          description: Machine-readable error code.
        message:
          type: string
          title: Message
          description: Human-readable error message.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: Optional structured error context.
      type: object
      required:
        - code
        - message
      title: PrimitiveError
    RetabUsage:
      properties:
        credits:
          type: number
          title: Credits
          description: Credits consumed for processing
      type: object
      required:
        - credits
      title: RetabUsage
      description: Usage information for document processing.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````