Skip to navigation

Get Files List

View as Markdown

Get Files List

Retrieve a list of files in a folder, with optional filtering/search and sorting.

Endpoint

GET {{base_url}}/files

Authentication

This endpoint requires Bearer Token authentication.

  • Header: Authorization: Bearer {{access_token}}

Ensure {{access_token}} is set to a valid JWT/token value in the active environment or collection variables.

Query parameters

ParameterRequiredTypeDescription
folder_idYesstring/numberFolder identifier to list files from.
searchNostringSearch term to filter files (e.g., filename).
starredNoboolean (true/false)Filter for starred files.
trashedNoboolean (true/false)Filter for trashed files.
sortNostringSort order (e.g., date).

Example request URL

{{base_url}}/files?folder_id={{folder_id}}&search=Frame 1000003420.png&starred=false&trashed=false&sort=date

Example response (outline)

{
"status": "OK",
"data": {
"files": [
{
"id": "<file_id>",
"name": "<filename>",
"url": "<file_url>",
"mime_type": "<mime_type>",
"size": <bytes>,
"starred": false,
"trashed": false,
"created_at": "<timestamp>",
"updated_at": "<timestamp>"
}
],
"pagination": {
"page": 1,
"per_page": 20,
"total": <count>
}
}
}

Query parameters

folder_idstringOptional
searchstringOptional
starredbooleanOptional
trashedbooleanOptional

Response

OK
dataobject
successboolean
total_trash_countinteger
total_starred_countinteger