Skip to main content
GET
/
files
List files in a directory
curl --request GET \
  --url https://api.openfiles.ai/functions/v1/api/files \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "data": {
    "files": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "path": "<string>",
        "version": 2,
        "mimeType": "<string>",
        "size": 1,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "total": 1,
    "limit": 2,
    "offset": 1
  },
  "operation": "list_files",
  "message": "Files listed successfully"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your API key from the console.

Query Parameters

​
directory
string
default:/

Directory to list files from

​
recursive
boolean
default:false

If true, lists all files across all directories. If false (default), only lists files in the specified directory.

​
contentType
string
​
limit
integer
default:10
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0
​
minSize
integer
Required range: x >= 0
​
maxSize
integer
Required range: x >= 0
​
createdAfter
string<date-time>
​
createdBefore
string<date-time>
​
updatedAfter
string<date-time>
​
updatedBefore
string<date-time>
​
sortBy
enum<string>
default:path
Available options:
path,
created_at,
updated_at,
size
​
sortOrder
enum<string>
default:asc
Available options:
asc,
desc

Response

Success

​
success
boolean
required
Example:

true

​
data
object
required
​
operation
string
required
Example:

"list_files"

​
message
string
required
Example:

"Files listed successfully"