List files

GET 
/openapi/2025-06/file

The Get File List API allows developers to retrieve a list of files stored on the server. This endpoint supports pagination and filtering based on the folder name.

Request

Query Parameters

folder string

The folder name to fetch files from. Defaults to "all_upload". Allowed values: -product - all_upload

cursor string

Cursor for pagination

page_size int32

The number of files to retrieve per page. Defaults to 20 if not specified. Must be greater than 0 and less than or equal to 300

page int32

Page number (1-based). Mutually exclusive with cursor

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

files object[]

The list of files

Array [

upload_linkstring

Upload file link

file_uristring

File uri

folderstring

Folder

sizeint32

File size

typestring

File type

origin_linkstring

Origin link

descstring

File description

aspect_ratiostring

File aspect ratio

widthint32

File width

heightint32

File height

created_atstring

Time of creation

updated_atstring

Time of update

]

cursorstring

The cursor for the next page of results

has_moreboolean

Whether there are more records

totalint32

Total number of records across all pages (for page-mode pagination)

Example

json

{
  "code": "string",
  "message": "string",
  "data": {
    "files": [
      {
        "upload_link": "string",
        "file_uri": "string",
        "folder": "string",
        "size": 0,
        "type": "string",
        "origin_link": "string",
        "desc": "string",
        "aspect_ratio": "string",
        "width": 0,
        "height": 0,
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "cursor": "string",
    "has_more": true,
    "total": 0
  }
}