List project files

GET

/projects/:projectId/files

GET

/projects/:projectId/files

1 curl https:/https://api/projects/projectId/files \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

1 {
2   "files": [
3     {
4       "_id": "f8a1c2d4-3b7e-4f9a-9d2e-1a2b3c4d5e6f",
5       "projectId": "proj_9f8e7d6c5b4a3210",
6       "filename": "project_overview.pdf",
7       "mimeType": "application/pdf",
8       "sizeBytes": 245760,
9       "r2Key": "files/proj_9f8e7d6c5b4a3210/project_overview.pdf",
10       "thumbnailR2Key": "thumbnails/proj_9f8e7d6c5b4a3210/project_overview_thumb.png",
11       "uploadedBy": "user_12345",
12       "uploadedAt": "2024-06-10T15:22:30Z",
13       "usedInRunIds": [
14         "run_20240610_001"
15       ],
16       "uploadedInRunId": "run_20240610_001",
17       "derivedFromFileId": null,
18       "tags": [
19         "documentation",
20         "overview"
21       ],
22       "archivedAt": null,
23       "folderId": "folder_abc123"
24     }
25   ],
26   "nextCursor": "eyJpZCI6ImY4YTFjMmQ0LTNiN2UtNGY5YS05ZDJlLTFhMmIzYzRkNWU2ZiIsImRhdGUiOiIyMDI0LTA2LTEwVDE1OjIyOjMwWiJ9"
27 }

Returns a keyset page of the project’s files. Supports filtering by folder/Inbox, tags (tags AND-list, tag nested-resolution), MIME, filename (q), and run usage, plus limit/cursor pagination and ?archived=true.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

projectIdstringRequired

Query parameters

folderIdstringOptional

inboxstringOptional

tagstringOptional

tagsstringOptional

mimestringOptional

qstringOptional

usedInRunIdstringOptional

archivedstringOptional

limitintegerOptional

cursorstringOptional

Response

A page of files.

fileslist of objects

nextCursorstring or null

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error