Files

List one level of a project's file browser

The folders and files directly inside folder_id (or the project root). Not recursive — walk down by passing a subfolder's id back. Files are paginated; folders are not. Requires operation files:read.

get/projects/{project_id}/files

Request

Base URL: https://app.fareeqy.com/api/v1
URL: https://app.fareeqy.com/api/v1/projects/{project_id}/files
Auth: HTTP bearer

Query parameters

folder_idinteger

The folder to list inside; omit for the project root.

limitinteger

Page size (default 50, max 100, clamped).

offsetinteger

Number of records to skip (default 0).

Response

One level of the file browser.

Example response

{
  "data": {
    "folder": {
      "id": 42,
      "url": "https://app.fareeqy.com/projects/prj-8f3kd/files?folder_id=42",
      "name": "التصاميم",
      "path": "التصاميم",
      "description": "ملفات الهوية وواجهات الموقع.",
      "parent_folder_id": null,
      "created_at": "2026-07-05T08:20:00.000+03:00"
    },
    "folders": [
      {
        "id": 42,
        "url": "https://app.fareeqy.com/projects/prj-8f3kd/files?folder_id=42",
        "name": "التصاميم",
        "path": "التصاميم",
        "description": "ملفات الهوية وواجهات الموقع.",
        "parent_folder_id": null,
        "created_at": "2026-07-05T08:20:00.000+03:00"
      }
    ],
    "files": [
      {
        "id": 108,
        "url": "https://app.fareeqy.com/files/fil-3qd8n",
        "name": "الهوية-البصرية.pdf",
        "path": "التصاميم/الهوية-البصرية.pdf",
        "folder_id": 42,
        "content_type": "application/pdf",
        "size_bytes": 2418176,
        "size_human": "2.31 م.بايت",
        "external_url": null,
        "source": null,
        "scan_state": "clean",
        "downloadable": true,
        "uploaded_by": "سارة العتيبي",
        "created_at": "2026-07-10T16:31:44.000+03:00"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.