Get a list of files from a specific source

get/sources/{sourceId}/files

Returns a list of files from a local source.

Request Samples

Response Samples

1{
2 "count": 3,
3 "items": [
4 {
5 "filepath": "example1.txt",
6 "insertTimestamp": "2025-12-12T10:15:30.123456+00:00",
7 "metadata": {
8 "size": 123,
9 "type": "text/plain"
10 },
11 "sourceFileId": "3c8b12a9-17d1-4f1b-822b-423ec8491bc0",
12 "sourceId": "079b46b9-fbc4-44ce-8cb1-163330e4d812",
13 "updateTimestamp": "2025-12-13T09:45:12.654321+00:00"
14 },
15 {
16 "filepath": "reports/2025-12-summary.pdf",
17 "insertTimestamp": "2025-12-12T11:20:05.000000+00:00",
18 "metadata": {
19 "size": 204800,
20 "type": "application/pdf"
21 },
22 "sourceFileId": "a1b2c3d4-1111-4f1b-822b-423ec8491bc0",
23 "sourceId": "079b46b9-fbc4-44ce-8cb1-163330e4d812",
24 "updateTimestamp": "2025-12-12T11:20:05.000000+00:00"
25 },
26 {
27 "filepath": "data/weather/daily_2025-12-13.csv",
28 "insertTimestamp": "2025-12-13T06:30:00.000000+00:00",
29 "metadata": {
30 "size": 9876,
31 "type": "text/csv"
32 },
33 "sourceFileId": "b2c3d4e5-2222-4f1b-822b-423ec8491bc0",
34 "sourceId": "079b46b9-fbc4-44ce-8cb1-163330e4d812",
35 "updateTimestamp": "2025-12-13T06:45:12.000000+00:00"
36 }
37 ],
38 "limit": 10,
39 "name": "sourceFiles",
40 "start": 0
41}

Path Parameters

NameTypeRequiredDescription
sourceId
string
true

The id of the source to retrieve all files.

Query Parameters

NameTypeRequiredDescription
limit
integer or null
false

The maximum number of files to be returned.

Default:
10
sortBy
string or null
false

The criteria for sorting. Supported attributes include sourceFileId, filepath, insertTimestamp, and updateTimestamp. Additional attributes might be added in future releases.

start
integer
false

Zero based offset of the first file to be returned.

>= 0
Default:
0

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
400Bad Request

The request was invalid.

Schema
401Unauthorized

The user was not authenticated.

Schema
422Unprocessable Entity

The server understands the request but was unable to process the contained instructions.

Schema