Read a drive item

GEThttps://<your-url>/api/v2/drive-items/{drive_item}

MCP id drive-items.showAlso on this path: PATCH Update a drive item, DELETE Archive a drive item

Returns one drive item 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 item with its owner and tags expanded

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

const response = await fetch('https://<your-url>/api/v2/drive-items/1?include=owner%2Cdrive_folder%2Ctags', {
  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-items/1?include=owner%2Cdrive_folder%2Ctags');

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

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "title": "Kick-off notes",
    "group": "…",
    "kind": "document",
    "source": "builtin",
    "folder_id": 1,
    "drive_folder": null,
    "owner_type": "project",
    "owner_id": 1,
    "owner": {
      "id": 1
    },
    "content_record_type": "drive_document",
    "content_record_id": 1
  },
  "meta": {
    "actions": [
      "restore"
    ]
  }
}

15 more fields, listed under Response

access is the calling user's own effective access level on it. The body is not here: read content_record_id and GET /api/v2/drive-documents/{drive_document} for it. owner, drive_folder and tags render as references until named in include; an organisation-owned item's owner is always a bare reference. An archived item is 404 unless trashed=with is passed, and trashed=only 404s a live one. The declared permission is project_drive::access; the other three drive prefixes apply by owner type, and the per-item rule is what actually decides.

Path parameters

drive_itemintegerRequired

The DriveItem's numeric id. Accepts a soft-deleted record.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

trashedstring

Whether soft-deleted rows are included.

withoutdefaultwithonly

metaarray of string

Optional meta members to compute for this response.

actions

New values may be added.

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 DriveItem 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.

titlestring≤ 255

Item title.

groupstring or null≤ 255

Free-text grouping label shown in the drive tree.

kindstring

What this item is. Everything created through the API is a document; the other kinds come from uploads in plnnrly.

document
pdf
image
audio
video
office
other

New values may be added.

sourcestring

Where the item came from: builtin for an editor document, upload for a file uploaded in plnnrly.

builtinupload

New values may be added.

folder_idinteger or null

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

drive_folderRef or DriveFolderSummary or null

The folder this item sits in; absent for items 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 item lives in. An organisation-owned item renders as a bare {"id": N} reference.

Which form you get depends on owner_type.

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

content_record_typestring or null

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

drive_document

New values may be added.

content_record_idinteger or null

The id of the record content_record points at.

content_recordRef or null

The body this item points at: a drive document for an editor document, null for an item with no body yet. Renders as a bare {"id": N} reference; read the body from GET /api/v2/drive-documents/{drive_document}.

Which form you get depends on content_record_type.

drive_document: Ref

order_columnintegerServer-assigned

Sort position, assigned by the server. Positions count per drive and folder, so the sequence is only meaningful once the collection is narrowed to one drive and one folder. 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.

archived_byinteger or nullServer-assigned

The user who archived this item; set on delete and cleared on restore.

inherits_permissionsboolean

Whether this item takes its permissions from its folder.

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 item, after the permission for the owner type, the access inherited from folders and any per-item 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.

deleted_attimestamp (YYYY-MM-DDThh:mm:ssZ) or null

When this item was archived, or null while it is live.

comments_countinteger≥ 0

Comments on this item.

files_countinteger≥ 0

Files attached to this item, counting the attachments list in plnnrly, the single uploaded file and the images embedded in the document body.

tags_countinteger≥ 0

Tags on this item.

linksDriveItemLinks

Show 3 child fields

links.selfurl

The canonical URI of this record.

links.commentsurl

Comments on this drive item.

links.filesurl

Files stored on this drive item.

tagsarray of TagSummary≤ 50Only with include

Tags on this item. An item takes at most 50 tags, so the include lists them all. tag_ids replaces the whole set.

Wrapped in { data, meta }; meta.truncated says whether the cap was hit and meta.count is the full count.

Show 2 child fields

tags.idinteger

Unique identifier.

tags.titlestring≤ 255

Tag title as shown in the UI.

Errors

403 Forbidden.

forbidden-by-policy insufficient-permission insufficient-token-scope

8 errors every operation can return: 304, 400, 401, 404, 406, 429, 500, 503

304 Not modified.

400 Bad request.

idempotency-key-required invalid-cursor invalid-query-parameter malformed-request unsupported-parameter

401 Unauthenticated.

token-expired unauthenticated

404 Not found.

endpoint-not-found resource-not-found

406 Not acceptable.

not-acceptable

429 Too many requests.

rate-limit-exceeded

500 Server error.

internal-error

503 Service unavailable.

tenant-unavailable

This path allows GET, PATCH, DELETE. Anything else answers 405.

Something wrong or missing on this page? Tell us

Access

Path parameters

Query parameters

Request headers

Response 200

Headers

Errors