File API
Version: 2.10.0
List folder contents
GET
/file/v2/orgs/{organisation_id}/workspaces/{workspace_id}/filesRequest to list files. The maximum number of results returned is limited to 5000.
Request
Responses
200
A list of files
Response schema
countinteger
filesobject[]
created_atdate-time
created_byobject | null
deleted_atstring | null
deleted_byobject | null
etagstring
file_iduuid
linksListFileLinks
Optional
selfstring
modified_atdate-time
modified_byobject | null
namestring
pathstring
sizeinteger
version_idint64
limitinteger
linksListFilesResponseLinks
nextstring | null
prevstring | null
selfstring
offsetinteger
totalinteger
Example response
{
"count": 0,
"files": [
{
"created_at": "2024-07-29T15:51:28.071Z",
"created_by": {
"email": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string"
},
"deleted_at": "2024-07-29T15:51:28.071Z",
"deleted_by": {
"email": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string"
},
"etag": "string",
"file_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"links": {
"self": "string"
},
"modified_at": "2024-07-29T15:51:28.071Z",
"modified_by": {
"email": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string"
},
"name": "string",
"path": "string",
"size": 0,
"version_id": "string"
}
],
"limit": 0,
"links": {
"next": "string",
"prev": "string",
"self": "string"
},
"offset": 0,
"total": 0
}
400
/file-api/files/invalid-path
Invalid request path.
/file-api/bad-request
Bad request. The server cannot or will not process the request due to a client error.
Response schema
Any of:
InvalidPathErrorobject
detailstring | null
statusinteger
Default:
400
titlestring
Default:
"Invalid Path."
typestring
Default:
"https://seequent.com/error-codes/file-api/files/invalid-path"
BadRequestErrorobject
detailstring | null
statusinteger
Default:
400
titlestring
Default:
"Bad Request."
typestring
Default:
"https://seequent.com/error-codes/file-api/bad-request"
Example response
{
"detail": "string",
"status": 400,
"title": "Invalid Path.",
"type": "https://seequent.com/error-codes/file-api/files/invalid-path"
}
401
/file-api/auth/missing-token
Unauthorized. The client request has not been completed as the provided credentials are invalid.
/file-api/auth/invalid-token
Forbidden. The client credentials are valid but do not permit access to this resource.
Response schema
Any of:
MissingTokenErrorobject
detailstring | null
statusinteger
Default:
401
titlestring
Default:
"Access Denied."
typestring
Default:
"https://seequent.com/error-codes/file-api/auth/missing-token"
InvalidTokenErrorobject
detailstring | null
statusinteger
Default:
401
titlestring
Default:
"Access Denied."
typestring
Default:
"https://seequent.com/error-codes/file-api/auth/invalid-token"
Example response
{
"detail": "string",
"status": 401,
"title": "Access Denied.",
"type": "https://seequent.com/error-codes/file-api/auth/missing-token"
}
403
/file-api/auth/insufficient-role
Forbidden. The client credentials are valid but the client does not have a sufficient role to access to this resource.
Response schema
detailstring | null
permitted_rolesarray
Default:
[]
statusinteger
Default:
403
titlestring
Default:
"Insufficient Role."
typestring
Default:
"https://seequent.com/error-codes/file-api/auth/insufficient-role"
your_rolestring
Example response
{
"detail": "string",
"permitted_roles": [
null
],
"status": 403,
"title": "Insufficient Role.",
"type": "https://seequent.com/error-codes/file-api/auth/insufficient-role",
"your_role": "string"
}
422
/file-api/validation
The request was invalid and will not be processed due to a client error.
Response schema
detailstring | null
statusinteger
Default:
422
titlestring
Default:
"Validation Error."
typestring
Default:
"https://seequent.com/error-codes/file-api/validation"
Example response
{
"detail": "string",
"status": 422,
"title": "Validation Error.",
"type": "https://seequent.com/error-codes/file-api/validation"
}
500
/file-api/api-errors
A server error has occurred.
Response schema
detailstring | null
statusinteger
Default:
500
titlestring
Default:
"An Error Occurred."
typestring
Default:
"https://seequent.com/error-codes/file-api/api-errors"
Example response
{
"detail": "string",
"status": 500,
"title": "An Error Occurred.",
"type": "https://seequent.com/error-codes/file-api/api-errors"
}
502
/file-api/metadata/store-error
A database error occurred when listing files.
/file-api/bad-gateway
Bad gateway. A response required to handle the request is invalid.
Response schema
Any of:
MetadataStoreErrorobject
detailstring | null
statusinteger
Default:
502
titlestring
Default:
"File Metadata Storage Operation Failed."
typestring
Default:
"https://seequent.com/error-codes/file-api/metadata/store-error"
BadGatewayobject
detailstring | null
statusinteger
Default:
502
titlestring
Default:
"Bad Gateway."
typestring
Default:
"https://seequent.com/error-codes/file-api/bad-gateway"
Example response
{
"detail": "string",
"status": 502,
"title": "File Metadata Storage Operation Failed.",
"type": "https://seequent.com/error-codes/file-api/metadata/store-error"
}