Misc · Drive
List folder contents
Returns the folders and files of a folder or the top level. Users without the drive permission only receive what is shared with them.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Also checked, depending on the request and the records it touches
drive.readuser.readapiKey.readcontact:member.readcontact:address.readcontact:customer.readcontact:sponsor.readcontact:contributor.readcontact:employee.readcontact:supplier.readcontact.read
Request
Path parameters
-
organizationIdidrequired
Body
Content-Type: application/json
-
folderIdidrequirednullable -
viewstringrequiredallshared -
searchTermstringat most 200 characters
-
kindsstring[]at most 10 items
imagevideoaudiopdfwordexcelpowerpointtextarchiveother -
sortstringrequirednameupdatedAtsize -
sortBystringrequiredascdesc -
limitintegerrequired1–500
-
offsetintegerrequiredat least 0
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/list' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/list", {
method: "POST",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'POST',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/list', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
Content-Type: application/json
-
canManageboolean -
managesContentsboolean -
folderobjectnullable14 properties
-
_idid -
parentidnullable -
namestring1–128 characters
-
colorstring22 values
slategrayzincneutralstoneredorangeamberyellowlimegreenemeraldtealcyanskyblueindigovioletpurplefuchsiapinkrose -
coverFileidnullable -
contentUpdatedAtstring · date-time -
createdAtstring · date-timenullable -
createdByobjectnullable -
fileCountintegerat least 0
-
folderCountintegerat least 0
-
sizeBytesnumberat least 0
-
shareCountintegerat least 0
-
peekFilesobject[]14 properties
-
_idid -
folderidnullable -
namestring1–128 characters
-
kindstringimagevideoaudiopdfwordexcelpowerpointtextarchiveother -
fileobject4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
thumbnailobjectnullable4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
widthintegernullable -
heightintegernullable -
durationSecondsnumbernullableat least 0
-
waveformnumber[]nullableat most 96 items · each 0–1
-
createdAtstring · date-timenullable -
createdByobjectnullable -
updatedAtstring · date-timenullable -
updatedByobjectnullable
-
-
coverobjectnullable14 properties
-
_idid -
folderidnullable -
namestring1–128 characters
-
kindstringimagevideoaudiopdfwordexcelpowerpointtextarchiveother -
fileobject4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
thumbnailobjectnullable4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
widthintegernullable -
heightintegernullable -
durationSecondsnumbernullableat least 0
-
waveformnumber[]nullableat most 96 items · each 0–1
-
createdAtstring · date-timenullable -
createdByobjectnullable -
updatedAtstring · date-timenullable -
updatedByobjectnullable
-
-
-
pathobject[]3 properties
-
_idid -
namestring1–128 characters
-
shareCountintegerat least 0
-
-
foldersobject[]14 properties
-
_idid -
parentidnullable -
namestring1–128 characters
-
colorstring22 values
slategrayzincneutralstoneredorangeamberyellowlimegreenemeraldtealcyanskyblueindigovioletpurplefuchsiapinkrose -
coverFileidnullable -
contentUpdatedAtstring · date-time -
createdAtstring · date-timenullable -
createdByobjectnullable -
fileCountintegerat least 0
-
folderCountintegerat least 0
-
sizeBytesnumberat least 0
-
shareCountintegerat least 0
-
peekFilesobject[]14 properties
-
_idid -
folderidnullable -
namestring1–128 characters
-
kindstringimagevideoaudiopdfwordexcelpowerpointtextarchiveother -
fileobject4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
thumbnailobjectnullable4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
widthintegernullable -
heightintegernullable -
durationSecondsnumbernullableat least 0
-
waveformnumber[]nullableat most 96 items · each 0–1
-
createdAtstring · date-timenullable -
createdByobjectnullable -
updatedAtstring · date-timenullable -
updatedByobjectnullable
-
-
coverobjectnullable14 properties
-
_idid -
folderidnullable -
namestring1–128 characters
-
kindstringimagevideoaudiopdfwordexcelpowerpointtextarchiveother -
fileobject4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
thumbnailobjectnullable4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
widthintegernullable -
heightintegernullable -
durationSecondsnumbernullableat least 0
-
waveformnumber[]nullableat most 96 items · each 0–1
-
createdAtstring · date-timenullable -
createdByobjectnullable -
updatedAtstring · date-timenullable -
updatedByobjectnullable
-
-
-
filesobject[]14 properties
-
_idid -
folderidnullable -
namestring1–128 characters
-
kindstringimagevideoaudiopdfwordexcelpowerpointtextarchiveother -
fileobject4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
thumbnailobjectnullable4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
widthintegernullable -
heightintegernullable -
durationSecondsnumbernullableat least 0
-
waveformnumber[]nullableat most 96 items · each 0–1
-
createdAtstring · date-timenullable -
createdByobjectnullable -
updatedAtstring · date-timenullable -
updatedByobjectnullable
-
-
recentFilesobject[]14 properties
-
_idid -
folderidnullable -
namestring1–128 characters
-
kindstringimagevideoaudiopdfwordexcelpowerpointtextarchiveother -
fileobject4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
thumbnailobjectnullable4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
widthintegernullable -
heightintegernullable -
durationSecondsnumbernullableat least 0
-
waveformnumber[]nullableat most 96 items · each 0–1
-
createdAtstring · date-timenullable -
createdByobjectnullable -
updatedAtstring · date-timenullable -
updatedByobjectnullable
-
-
hasMoreFilesboolean
{
"canManage": true,
"managesContents": true,
"folder": {
"_id": "000000000000000000000001",
"parent": "000000000000000000000001",
"name": "string",
"color": "slate",
"coverFile": "000000000000000000000001",
"contentUpdatedAt": "2026-06-15T22:30:00Z",
"fileCount": 0,
"folderCount": 0,
"sizeBytes": 0,
"shareCount": 0,
"peekFiles": [
{
"_id": "000000000000000000000001",
"folder": "000000000000000000000001",
"name": "string",
"kind": "image",
"file": {
"resource": "string"
},
"thumbnail": {
"resource": "string"
},
"width": 1,
"height": 1,
"durationSeconds": 0,
"waveform": [
0
]
}
],
"cover": {
"_id": "000000000000000000000001",
"folder": "000000000000000000000001",
"name": "string",
"kind": "image",
"file": {
"resource": "string"
},
"thumbnail": {
"resource": "string"
},
"width": 1,
"height": 1,
"durationSeconds": 0,
"waveform": [
0
]
}
},
"path": [
{
"_id": "000000000000000000000001",
"name": "string",
"shareCount": 0
}
],
"folders": [
{
"_id": "000000000000000000000001",
"parent": "000000000000000000000001",
"name": "string",
"color": "slate",
"coverFile": "000000000000000000000001",
"contentUpdatedAt": "2026-06-15T22:30:00Z",
"fileCount": 0,
"folderCount": 0,
"sizeBytes": 0,
"shareCount": 0,
"peekFiles": [
{
"_id": "000000000000000000000001",
"folder": "000000000000000000000001",
"name": "string",
"kind": "image",
"file": {
"resource": "string"
},
"thumbnail": {
"resource": "string"
},
"width": 1,
"height": 1,
"durationSeconds": 0,
"waveform": [
0
]
}
],
"cover": {
"_id": "000000000000000000000001",
"folder": "000000000000000000000001",
"name": "string",
"kind": "image",
"file": {
"resource": "string"
},
"thumbnail": {
"resource": "string"
},
"width": 1,
"height": 1,
"durationSeconds": 0,
"waveform": [
0
]
}
}
],
"files": [
{
"_id": "000000000000000000000001",
"folder": "000000000000000000000001",
"name": "string",
"kind": "image",
"file": {
"resource": "string"
},
"thumbnail": {
"resource": "string"
},
"width": 1,
"height": 1,
"durationSeconds": 0,
"waveform": [
0
]
}
],
"recentFiles": [
{
"_id": "000000000000000000000001",
"folder": "000000000000000000000001",
"name": "string",
"kind": "image",
"file": {
"resource": "string"
},
"thumbnail": {
"resource": "string"
},
"width": 1,
"height": 1,
"durationSeconds": 0,
"waveform": [
0
]
}
],
"hasMoreFiles": true
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.