Alpha AnalystDocs
API Portal

User Files API

Platform-linked

Platform-linked: the key’s login needs an API plan and a website plan with Files; ApiKey only. How this works.

Browse folders and files in your upload library, or search by filename. Requires sign-in.

curl -X GET "https://example.com/v2/user/files?size=20"
{  "results": [],  "count": 0,  "size": 20,  "truncated": false,  "path": [    {      "folder_id": "main",      "name": "main"    }  ],  "parent_folder_id": "main",  "parent_name": "main"}
GET
/v2/user/files

Query Parameters

parent_folder_id?string

Folder to list or to restrict a name search. Omit with query to search the whole library. Omit without query to list main (the root). Pass main for the root folder.

Length1 <= length <= 80
query?string

Name search over files and folders. Omit to list the folder.

Length1 <= length <= 200
kind?string

file or folder. Omit to return both.

Value in

  • "file"
  • "folder"
size?integer

Page size. Default 50. Maximum 100.

Range1 <= value <= 100
Default50

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json