Skip to content
campaiDeveloper
campai.com

Misc · Drive

POST/{organizationId}/misc/drive/listReads only

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.read
  • user.read
  • apiKey.read
  • contact:member.read
  • contact:address.read
  • contact:customer.read
  • contact:sponsor.read
  • contact:contributor.read
  • contact:employee.read
  • contact:supplier.read
  • contact.read

Request

Path parameters

  • organizationIdidrequired

Body

Content-Type: application/json

  • folderIdidrequirednullable
  • viewstringrequired
    all shared
  • searchTermstring

    at most 200 characters

  • kindsstring[]

    at most 10 items

    image video audio pdf word excel powerpoint text archive other
  • sortstringrequired
    name updatedAt size
  • sortBystringrequired
    asc desc
  • limitintegerrequired

    1–500

  • offsetintegerrequired

    at least 0

Request
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'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • canManageboolean
  • managesContentsboolean
  • folderobjectnullable
    14 properties
    • _idid
    • parentidnullable
    • namestring

      1–128 characters

    • colorstring
      22 values
      slate gray zinc neutral stone red orange amber yellow lime green emerald teal cyan sky blue indigo violet purple fuchsia pink rose
    • coverFileidnullable
    • contentUpdatedAtstring · date-time
    • createdAtstring · date-timenullable
    • createdByobjectnullable
    • fileCountinteger

      at least 0

    • folderCountinteger

      at least 0

    • sizeBytesnumber

      at least 0

    • shareCountinteger

      at least 0

    • peekFilesobject[]
      14 properties
      • _idid
      • folderidnullable
      • namestring

        1–128 characters

      • kindstring
        image video audio pdf word excel powerpoint text archive other
      • fileobject
        4 properties
        • resourcestring

          at least 1 characters

        • fileNamestring

          at most 128 characters

        • contentTypestring

          at most 75 characters

        • fileSizeBytesinteger

          at least 0

      • thumbnailobjectnullable
        4 properties
        • resourcestring

          at least 1 characters

        • fileNamestring

          at most 128 characters

        • contentTypestring

          at most 75 characters

        • fileSizeBytesinteger

          at least 0

      • widthintegernullable
      • heightintegernullable
      • durationSecondsnumbernullable

        at least 0

      • waveformnumber[]nullable

        at most 96 items · each 0–1

      • createdAtstring · date-timenullable
      • createdByobjectnullable
      • updatedAtstring · date-timenullable
      • updatedByobjectnullable
    • coverobjectnullable
      14 properties
      • _idid
      • folderidnullable
      • namestring

        1–128 characters

      • kindstring
        image video audio pdf word excel powerpoint text archive other
      • fileobject
        4 properties
        • resourcestring

          at least 1 characters

        • fileNamestring

          at most 128 characters

        • contentTypestring

          at most 75 characters

        • fileSizeBytesinteger

          at least 0

      • thumbnailobjectnullable
        4 properties
        • resourcestring

          at least 1 characters

        • fileNamestring

          at most 128 characters

        • contentTypestring

          at most 75 characters

        • fileSizeBytesinteger

          at least 0

      • widthintegernullable
      • heightintegernullable
      • durationSecondsnumbernullable

        at least 0

      • waveformnumber[]nullable

        at most 96 items · each 0–1

      • createdAtstring · date-timenullable
      • createdByobjectnullable
      • updatedAtstring · date-timenullable
      • updatedByobjectnullable
  • pathobject[]
    3 properties
    • _idid
    • namestring

      1–128 characters

    • shareCountinteger

      at least 0

  • foldersobject[]
    14 properties
    • _idid
    • parentidnullable
    • namestring

      1–128 characters

    • colorstring
      22 values
      slate gray zinc neutral stone red orange amber yellow lime green emerald teal cyan sky blue indigo violet purple fuchsia pink rose
    • coverFileidnullable
    • contentUpdatedAtstring · date-time
    • createdAtstring · date-timenullable
    • createdByobjectnullable
    • fileCountinteger

      at least 0

    • folderCountinteger

      at least 0

    • sizeBytesnumber

      at least 0

    • shareCountinteger

      at least 0

    • peekFilesobject[]
      14 properties
      • _idid
      • folderidnullable
      • namestring

        1–128 characters

      • kindstring
        image video audio pdf word excel powerpoint text archive other
      • fileobject
        4 properties
        • resourcestring

          at least 1 characters

        • fileNamestring

          at most 128 characters

        • contentTypestring

          at most 75 characters

        • fileSizeBytesinteger

          at least 0

      • thumbnailobjectnullable
        4 properties
        • resourcestring

          at least 1 characters

        • fileNamestring

          at most 128 characters

        • contentTypestring

          at most 75 characters

        • fileSizeBytesinteger

          at least 0

      • widthintegernullable
      • heightintegernullable
      • durationSecondsnumbernullable

        at least 0

      • waveformnumber[]nullable

        at most 96 items · each 0–1

      • createdAtstring · date-timenullable
      • createdByobjectnullable
      • updatedAtstring · date-timenullable
      • updatedByobjectnullable
    • coverobjectnullable
      14 properties
      • _idid
      • folderidnullable
      • namestring

        1–128 characters

      • kindstring
        image video audio pdf word excel powerpoint text archive other
      • fileobject
        4 properties
        • resourcestring

          at least 1 characters

        • fileNamestring

          at most 128 characters

        • contentTypestring

          at most 75 characters

        • fileSizeBytesinteger

          at least 0

      • thumbnailobjectnullable
        4 properties
        • resourcestring

          at least 1 characters

        • fileNamestring

          at most 128 characters

        • contentTypestring

          at most 75 characters

        • fileSizeBytesinteger

          at least 0

      • widthintegernullable
      • heightintegernullable
      • durationSecondsnumbernullable

        at least 0

      • waveformnumber[]nullable

        at most 96 items · each 0–1

      • createdAtstring · date-timenullable
      • createdByobjectnullable
      • updatedAtstring · date-timenullable
      • updatedByobjectnullable
  • filesobject[]
    14 properties
    • _idid
    • folderidnullable
    • namestring

      1–128 characters

    • kindstring
      image video audio pdf word excel powerpoint text archive other
    • fileobject
      4 properties
      • resourcestring

        at least 1 characters

      • fileNamestring

        at most 128 characters

      • contentTypestring

        at most 75 characters

      • fileSizeBytesinteger

        at least 0

    • thumbnailobjectnullable
      4 properties
      • resourcestring

        at least 1 characters

      • fileNamestring

        at most 128 characters

      • contentTypestring

        at most 75 characters

      • fileSizeBytesinteger

        at least 0

    • widthintegernullable
    • heightintegernullable
    • durationSecondsnumbernullable

      at least 0

    • waveformnumber[]nullable

      at most 96 items · each 0–1

    • createdAtstring · date-timenullable
    • createdByobjectnullable
    • updatedAtstring · date-timenullable
    • updatedByobjectnullable
  • recentFilesobject[]
    14 properties
    • _idid
    • folderidnullable
    • namestring

      1–128 characters

    • kindstring
      image video audio pdf word excel powerpoint text archive other
    • fileobject
      4 properties
      • resourcestring

        at least 1 characters

      • fileNamestring

        at most 128 characters

      • contentTypestring

        at most 75 characters

      • fileSizeBytesinteger

        at least 0

    • thumbnailobjectnullable
      4 properties
      • resourcestring

        at least 1 characters

      • fileNamestring

        at most 128 characters

      • contentTypestring

        at most 75 characters

      • fileSizeBytesinteger

        at least 0

    • widthintegernullable
    • heightintegernullable
    • durationSecondsnumbernullable

      at least 0

    • waveformnumber[]nullable

      at most 96 items · each 0–1

    • createdAtstring · date-timenullable
    • createdByobjectnullable
    • updatedAtstring · date-timenullable
    • updatedByobjectnullable
  • hasMoreFilesboolean
Response200
{
  "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.