API SpecificationFolders
List folders
Lists folders in a bucket directory, optionally including breadcrumb navigation.
Authorization
OAuth2 upl:bucket:readAuthorizationBearer <token>
OAuth 2.0 authorization
In: header
Scope: upl:bucket:read
Header Parameters
Connect-Protocol-Version*number
Define the version of the Connect protocol
Value in
1Connect-Timeout-Ms?number
Define the timeout, in ms
Request Body
application/json
bucketRef?|
Reference to the bucket
folder?|
Directory to list folders from
includeBreadcrumbs?boolean
[key: string]?never
Response Body
application/json
application/json
curl -X POST "https://uploads-api.xeonr.io/uplim.api.v1.BucketFoldersService/ListFolders" \ -H "Connect-Protocol-Version: 1" \ -H "Content-Type: application/json" \ -d '{}'{
"folders": [
{
"folderId": "string",
"path": "string",
"parentPath": "string",
"colour": "string",
"hasPublicDirectoryListing": true,
"inheritedHasDirectoryListing": true,
"privateAccess": true,
"inheritedPrivateAccess": true,
"isShareRoot": true,
"scopingOauthClientId": "dfbc0836-6edf-40f5-a722-cd887dfac017",
"scopingOauthClient": {
"clientId": "string",
"name": "string",
"websiteUrl": "string",
"logoUrl": "string",
"description": "string",
"isVerified": true,
"createdAt": "2023-01-15T01:30:15.01Z",
"applicationBindings": [
{
"applicationId": "string",
"config": {
"jsonConfig": {
"property1": {},
"property2": {}
}
}
}
]
}
}
],
"breadcrumbs": [
{
"folderId": "string",
"path": "string",
"parentPath": "string",
"colour": "string",
"hasPublicDirectoryListing": true,
"inheritedHasDirectoryListing": true,
"privateAccess": true,
"inheritedPrivateAccess": true,
"isShareRoot": true,
"scopingOauthClientId": "dfbc0836-6edf-40f5-a722-cd887dfac017",
"scopingOauthClient": {
"clientId": "string",
"name": "string",
"websiteUrl": "string",
"logoUrl": "string",
"description": "string",
"isVerified": true,
"createdAt": "2023-01-15T01:30:15.01Z",
"applicationBindings": [
{
"applicationId": "string",
"config": {
"jsonConfig": {
"property1": {},
"property2": {}
}
}
}
]
}
}
]
}{
"code": "not_found",
"message": "string",
"details": [
{
"type": "string",
"value": "string",
"debug": {}
}
]
}