DriveItem

A file or document in a drive: the rows plnnrly's file browser lists under a project, a customer, the organisation drive or a user's personal drive.

View as Markdown

Summary view: DriveItemList, 27 fields. What a list returns by default.
Detail view: DriveItem, 27 fields. The default for a single read and for every write.
Read with: api:read:project_driveorapi:read:customer_driveorapi:read:organization_driveorapi:read:user_driveandproject_drive::access
Write with: api:write:project_driveorapi:write:customer_driveorapi:write:organization_driveorapi:write:user_driveandproject_drive::create

Example

detail view

{
  "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,
  "content_record": null,
  "order_column": 1,
  "created_by": 1,
  "archived_by": 1,
  "inherits_permissions": false,
  "general_access": "everyone_edit",
  "access": "view",
  "created_at": "2026-03-04T09:15:00Z",
  "updated_at": "2026-03-04T09:15:00Z",
  "deleted_at": "2026-03-04T09:15:00Z",
  "comments_count": 1,
  "files_count": 1,
  "tags_count": 1,
  "tags": {
    "data": [
      {
        "…": "2 fields of TagSummary"
      }
    ],
    "meta": {
      "truncated": false,
      "…": "1 optional field left out"
    }
  },
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1",
    "comments": "https://<your-url>/api/v2/work-items/1",
    "files": "https://<your-url>/api/v2/work-items/1"
  }
}

A drive item is the envelope (title, folder, tags, sharing tier), and its body, where it has one, lives on the drive document it points at through content_record. Access is decided per item: the permission for the owner type, then the folders it inherits from, then any per-item grant.

Used by

GETList drive items/drive-itemsDriveItemList

POSTCreate a drive item/drive-itemsDriveItem

GETRead a drive item/drive-items/{drive_item}DriveItem

PATCHUpdate a drive item/drive-items/{drive_item}DriveItem

POSTRestore an archived drive item/drive-items/{drive_item}/actions/restoreDriveItem

Fields

Detail only: Only in the detail view.
Only with include: Only when you ask for it with include.
Server-assigned: Set by plnnrly, never by a request.

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.

Variants

DriveItemList 27 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

DriveItemSummary 5 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: group, kind, source, folder_id, drive_folder, content_record_type, content_record_id, content_record, order_column, created_by, archived_by, inherits_permissions, general_access, access, created_at, updated_at, deleted_at, comments_count, files_count, tags_count, tags, links

owner narrows from Ref or ProjectSummary or CustomerSummary or UserSummary to Ref.

DriveItemLinks 3 fields

The links object on this resource.

Keys: self, comments, files

Polymorphic fields

ownerWhich form you get depends on owner_type.

content_recordWhich form you get depends on content_record_type.

Something wrong or missing on this page? Tell us