---
title: "List files"
method: GET
path: "/workspaces/{workspace_id}/projects/{project_id}/files"
tags: ["Files"]
---

# List files

`GET /workspaces/{workspace_id}/projects/{project_id}/files`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/workspaces/{workspace_id}/projects/{project_id}/files`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-KEY` and API key in header `X-API-SECRET` and API key in header `X-WORKSPACE-ID`

Returns list of webhook details. Query parameters can be used to optimize the response.

## Path parameters

- `workspace_id` integer, required: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
- `project_id` integer, required: Project ID of the workspace

## Query parameters

- `fields` string, nullable: Fields to be returned in a comma-separated format may include id, name, status_info, created_at.
- `id` string: Track multiple file ids, comma separated
- `name` string, nullable: Track multiple file names, comma separated
- `status` string, nullable: Track multiple file statuses, comma separated
- `created_at` string, nullable: Track multiple files, which falls under created_at date range
- `updated_at` string, nullable: Track multiple files, which falls under updated_at date range
- `limit` integer: Max number of result to return
- `offset` integer: Distance from the beginning of the list of results
- `sort` string, nullable: Sort the files based on the fields
- `extension` string, nullable: Case-insensitive file extension to filter files by, with or without a leading dot

## Response `200`

List files

- FilesList
  - `files` FilesStandardSchema[], required
    - `id` integer, required: File Id
    - `name` string, required: File Name
    - `status` string, required: Status of the file
    - `created_at` string, date-time, required: Created At
    - `last_updated_at` string, date-time, required: Updated At
    - `status_info` StatusInfo, required: Status Info of the file
      - `extracting` string, nullable: Status extracting info
      - `extracted` string, nullable: Status extracted info
      - `action_needed` string, nullable: Status action needed info
      - `processing` string, nullable: Status processing info
      - `processed` string, nullable: Status processed info
      - `error` string, nullable: Status error info
      - `is_hidden` boolean: Is Hidden
      - `is_empty` boolean: Is Empty
    - `additional_info` AdditionalInfo, required: Additional Info of the file
      - `append_to_ds_id` integer, nullable: File Id
      - `parent_id` string, nullable: Parent Id
      - `delete_existing_after_append` boolean: Delete Existing After Append
      - `password_protected` boolean: Password Protected
      - `sheets_info` SheetInfo[], nullable: Sheet Info
        - `sheet_name` string, required: Sheet Name
        - `num_rows` integer, required: Number of rows in a sheet
        - `num_cols` integer, required: Number of columns in a sheet
      - `final_ds_id` integer, nullable: Final Dataset Id
      - `url` string, nullable: Final Dataset Id
      - `pdf_status_code` string, nullable: Processing status code
      - `pdf_total_pages` integer, nullable: The total number of pages present in the PDF document.
      - `extraction_method` string, nullable: The method used for table extraction
      - `user_instruction` string, nullable: User-provided instruction text
      - `user_instruction_type` string, nullable: Type of user instruction (e.g., EXTRACT_TEXT)
      - `job_id` integer, nullable: Associated job or future ID
      - `pdf_s3_link` string, nullable: URL of the uploaded PDF file stored in the S3 bucket.
      - `preview_page` integer, nullable: Page numnber chosen for Preview
      - `table_info` object, nullable: Response object containing table extraction results with status, details, and extracted tables data.
      - `cached_extractions` CachedExtractionInfo[], nullable: Previously-run extraction modes for this PDF whose results are cached and can be restored instantly
        - `extraction_method` string, nullable: The method used for this cached extraction
        - `user_instruction` string, nullable: User-provided instruction text for this cached extraction
        - `created_at` string, nullable: When this cached extraction was produced
        - `table_info` object, nullable: The full extraction result for this cached mode — same shape as AdditionalInfo.table_info — so the FE can restore it instantly without a further request.
  - `limit` integer
  - `offset` integer
  - `next` string, required

## Other responses

- `400`: Bad Request
- `401`: Authorization error

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/9d8804f81a10?raw)