Read a drive folder

GEThttps://<your-url>/api/v2/drive-folders/{drive_folder}

MCP id drive-folders.showAlso on this path: PATCH Update a drive folder, DELETE Delete a drive folder

Returns one drive folder in the detail view.

Token scope: api:read:project_driveorapi:read:customer_driveorapi:read:organization_driveorapi:read:user_drive
Without it: 403 insufficient-token-scope.
Permission: project_drive::access
Without it: 403 insufficient-permission.
Rate cost: 1 unit, read bucket.
Also: If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: One folder with its owner and parent expanded

curl -G \
  'https://<your-url>/api/v2/drive-folders/1' \
  --data-urlencode 'include=owner,parent_folder' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/drive-folders/1?include=owner%2Cparent_folder', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/drive-folders/1?include=owner%2Cparent_folder');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/drive-folders/1?include=owner%2Cparent_folder',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "name": "Kick-off",
    "parent_id": 1,
    "parent_folder": null,
    "owner_type": "project",
    "owner_id": 1,
    "owner": {
      "id": 1
    },
    "order": 1,
    "created_by": 1,
    "inherits_permissions": false,
    "general_access": "everyone_edit",
    "access": "view"
  }
}

4 more fields, listed under Response

access is the calling user's own effective access level on it. owner and parent_folder render as references until named in include; an organisation-owned folder's owner is always a bare reference. The folder's contents are two other reads: data.links.drive_items for its items, and GET /api/v2/drive-folders?filter[parent_id]={id} for its subfolders. A folder is hard-deleted, so there is no trashed parameter. The declared permission is project_drive::access; the other three drive prefixes apply by owner type, and the per-folder rule is what actually decides.

Path parameters

drive_folderintegerRequired

The DriveFolder's numeric id.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a DriveFolder in the detail view.

Headers

ETag: A strong validator of exactly this representation.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning

idinteger

Unique identifier.

namestring≤ 255

Folder name as shown in the drive tree.

parent_idinteger or null

Folder this one sits in, or null at the drive root.

parent_folderRef or DriveFolderSummary or null

The folder this one sits in; absent for folders at the drive root.

owner_typestring

The kind of record owner points at; it says which branch of owner applies.

projectcustomerorganizationuser

New values may be added.

owner_idinteger

The id of the record owner points at.

ownerRef or ProjectSummary or CustomerSummary or UserSummary

The project, customer, organisation or user whose drive this folder lives in. An organisation-owned folder renders as a bare {"id": N} reference.

Which form you get depends on owner_type.

project: ProjectSummary
customer: CustomerSummary
organization: Ref
user: UserSummary

orderintegerServer-assigned

Sort position within the drive and level, as shown in the drive tree. Positions count per drive and level, so the sequence is only meaningful once the collection is narrowed to one drive and one level. It is not assigned on create, so a folder created through the API stays at 0 until it is positioned in plnnrly; reordering is not exposed in v2.0.

created_byinteger or nullServer-assigned

Author; always the authenticated user at create time. Null on legacy rows and where the author has since been deleted.

inherits_permissionsboolean

Whether this folder takes its permissions from its parent.

general_accessstring

Baseline sharing tier, consulted only while inherits_permissions is false.

everyone_editeveryone_viewrestricted

New values may be added.

accessstring or null

The calling user's effective access level on this folder, after the permission for the owner type, the access inherited from folders and any per-folder grant.

viewedit

New values may be added.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync.

drive_items_countinteger≥ 0

Live drive items directly in this folder that the caller may see. Archived items are not counted, and neither are items in subfolders.

linksDriveFolderLinks

Show 2 child fields

links.selfurl

The canonical URI of this record.