List files | Flatfile | API Reference

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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"

Allowed values:

This endpoint returns an object.

datalist of objects

paginationobject or null

pagination info

1	{
2	"data": [
3	{
4	"id": "us_fl_YOUR_ID",
5	"name": "Test File",
6	"ext": "csv",
7	"mimetype": "text/csv",
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	"description": "This is a test file",
16	"mode": "import"
17	}
18	],
19	"pagination": {
20	"currentPage": 3,
21	"pageCount": 50,
22	"totalCount": 100
23	}
24	}

1	import { FlatfileClient } from "@flatfile/api";
2
3	const client = new FlatfileClient({ token: "YOUR_TOKEN" });
4	await client.files.list();