Home/Documents/Data Structures

Documents Data Structures

Field definitions for key objects returned by Documents APIs.

ID Format

Resources use prefixed public IDs (for example deal_..., inv_..., form_..., ak_...).

Folder object

Object representing a folder for organizing documents. Folders can be nested by specifying a parent_id.

Fields

Name	Type	Required	Description
id	string	Required	Folder ID
object	string	Required	Object type (`docs.folder`)
organization_id	string	Required	Organization ID
name	string	Required	Folder name
parent_id	string \| null	Optional	Parent folder ID (null for root)
created_by	string \| null	Optional	Creator ID
created_at	string	Required	Created at (ISO 8601)
updated_at	string	Required	Updated at (ISO 8601)

{
  "id": "folder_01JQ3KABC",
  "object": "docs.folder",
  "organization_id": "org_01HZXYZ",
  "name": "Product Requirements",
  "parent_id": null,
  "created_by": "usr_01HZABC",
  "created_at": "2026-02-10T09:00:00Z",
  "updated_at": "2026-02-20T15:30:00Z"
}

Document object

Object representing a document. Versions are automatically saved on update.

Fields

Name	Type	Required	Description
id	string	Required	Document ID
object	string	Required	Object type (`docs.document`)
organization_id	string	Required	Organization ID
title	string	Required	Title
content	string \| null	Optional	Content (JSON)
status	"draft" \| "review" \| "published" \| "archived"	Required	Status (draft, review, published, archived)
folder_id	string \| null	Optional	Folder ID
category	string \| null	Optional	Category
tags	string \| null	Optional	Tags (comma-separated)
version	integer	Required	Current version number
created_by	string \| null	Optional	Creator ID
updated_by	string \| null	Optional	Last updated by ID
created_at	string	Required	Created at (ISO 8601)
updated_at	string	Required	Updated at (ISO 8601)

{
  "id": "doc_01JQ3KXYZ",
  "object": "docs.document",
  "organization_id": "org_01HZXYZ",
  "title": "Product Requirements Document",
  "content": null,
  "status": "draft",
  "folder_id": "folder_01JQ3KABC",
  "category": "engineering",
  "tags": "product,requirements",
  "version": 3,
  "created_by": "usr_01HZABC",
  "updated_by": "usr_01HZDEF",
  "created_at": "2026-02-10T09:00:00Z",
  "updated_at": "2026-02-20T15:30:00Z"
}

Version object

Object representing a version snapshot of a document. The previous content is automatically saved when a document is updated.

Fields

Name	Type	Required	Description
id	string	Required	Version ID
object	string	Required	Object type (`docs.version`)
document_id	string	Required	Document ID
version	integer	Required	Version number
content	string \| null	Optional	Content at this version (JSON)
created_by	string \| null	Optional	Creator ID
created_at	string	Required	Created at (ISO 8601)

{
  "id": "ver_01JQ3KVRS",
  "object": "docs.version",
  "document_id": "doc_01JQ3KXYZ",
  "version": 2,
  "content": "{\"type\":\"doc\",\"content\":[]}",
  "created_by": "usr_01HZABC",
  "created_at": "2026-02-18T12:00:00Z"
}