Across 6 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
file 9
GET
/v1/org/{orgId}/file
Returns a list of files
findFiles9 params→ 200401403404
POST
/v1/org/{orgId}/file
Upload a new file
uploadFile11 params→ 201400401
GET
/v1/org/{orgId}/file/data
Query files with additional person field data
queryFiles10 params→ 200400401403
POST
/v1/org/{orgId}/file/export
Export a zipfile of files matching some criteria
exportFiles2 params→ 201400401403404
POST
/v1/org/{orgId}/file/export-csv
Export a CSV of file metadata matching some criteria
exportFilesCsv2 params→ 201400401403404
GET
/v1/org/{orgId}/file/{fileId}
Returns metadata about a file
getFileMetadata2 params→ 200401403404
PATCH
/v1/org/{orgId}/file/{fileId}
Update a file's metadata
updateFile3 params→ 204400401403404
DELETE
/v1/org/{orgId}/file/{fileId}
Delete a file
deleteFile2 params→ 204400401403404
GET
/v1/org/{orgId}/file/{fileId}/download
Download a file
downloadFile2 params→ 401403404
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are FileEntity (33 properties), Process (29 properties), FileExportCsvParams (8 properties), Attribution (6 properties). Each schema is shown below with its type and property counts.
AccessAction
object
3 properties1 required
Process
object
29 properties9 required
FileExportCsvParams
object
8 properties
ResultsAccess
object
2 properties1 required
UpdateFileEntity
object
4 properties
LogData
object
4 properties3 required
ResultsFileEntity
object
3 properties1 required
Attribution
object
6 properties
FileExportParams
object
5 properties
FileEntity
object
33 properties9 required
ResultsData
object
4 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
