Get

[POST] .../v1/file/get

Returns a list of files available to the current user with file and folder ACL applied. Use this method to retrieve files visible to the current request user before downloading, previewing, attaching or moving files in REGOS file storage. The response returns paged file records with folder metadata, CDN URL, owner, access level, content hash, MIME/media metadata, next_offset and total. The request body is required and supports filters id, user_id, folder_id, access_level and name while keeping ids and search as aliases; sort_orders supports date, name and size. Access is limited by file select permission, file ownership, access_level, folder ACL and the permission to work with all files; a missing body, denied permission, inaccessible folder, invalid filters or sort_orders, CDN token errors and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of records to return. The value is limited by server settings.
offset Int32 Optional Offset from the beginning of the result set.
search String Optional Search by file name.
sort_orders Array of CommonFileSortOrder Optional Output data sorting. Supported columns are date, name and size.

Filterable Fields

Field Type Description
access_level string Access level filter.
folder_id int Filter by folder.
id int Filter by file IDs.
name string
user_id int Owner filter.

Sortable Fields

Field
date
name
size

Request Example

{
  "filters": [
    {
      "field": "folder_id",
      "operator": "Equal",
      "value": "10"
    },
    {
      "field": "access_level",
      "operator": "Equal",
      "value": "Personal"
    },
    {
      "field": "name",
      "operator": "Like",
      "value": "invoice"
    }
  ],
  "sort_orders": [
    {
      "column": "date",
      "direction": "DESC"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of CommonFile Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 101,
      "name": "invoice_2026_01.pdf",
      "size": 34567,
      "extension": "pdf",
      "mime_type": "application/pdf",
      "media_type": "document",
      "width": null,
      "height": null,
      "duration_ms": null,
      "aspect_ratio": null,
      "date": 1767225600,
      "user_id": 501,
      "access_level": "personal",
      "hash": "ab52f8ce4f4e9f8b7f1d4b9d3c12e6a8b0f1e2345f6a7b8c9d0e1f2a3b4c5d6e",
      "folder": {
        "id": 10,
        "name": "Invoices",
        "path": "/Invoices",
        "parent_id": 1,
        "user_id": 501,
        "access_level": "personal",
        "date": 1767139200,
        "last_update": 1767139200,
        "deleted": false
      },
      "folder_id": 10,
      "url": "https://cdn.example.com/files/101",
      "last_update": 1767229200
    }
  ],
  "next_offset": 0,
  "total": 1
}