Files

List files

GET

Query parameters

spaceIdstringOptional
pageSizeintegerOptional
Number of files to return in a page (default 20)
pageNumberintegerOptional
Based on pageSize, which page of files to return
modeenumOptional
The storage mode of file to fetch, defaults to "import"

Response

This endpoint returns an object
data
list of objects
Any uploaded file of any type
pagination
objectOptional
pagination info
GET
$curl https://api.x.flatfile.com/v1/files \
> -H "Authorization: Bearer <token>"
Response
1{
2 "data": [
3 {
4 "id": "us_fl_YOUR_ID",
5 "name": "Test File",
6 "ext": "png",
7 "mimetype": "image/png",
8 "encoding": "7bit",
9 "status": "partial",
10 "size": 81953,
11 "bytesReceived": 81593,
12 "createdAt": "2023-11-15T19:31:33.015Z",
13 "updatedAt": "2023-11-15T19:31:33.015Z",
14 "spaceId": "us_sp_YOUR_ID",
15 "mode": "import"
16 }
17 ],
18 "pagination": {
19 "currentPage": 3,
20 "pageCount": 50,
21 "totalCount": 100
22 }
23}