ホーム/Doc（ドキュメント管理）/データ構造

Doc データ構造

Doc API で返却される主要オブジェクトのフィールド定義です。

ID 形式

各リソースは prefix 付き public ID（例: deal_..., inv_..., form_..., ak_...）を利用します。

Folder object

ドキュメントを整理するためのフォルダを表すオブジェクトです。フォルダは parent_id を指定してネスト可能です。

フィールド

名前	型	必須	説明
id	string	必須	フォルダ ID
object	string	必須	オブジェクト種別（`docs.folder`）
organization_id	string	必須	組織 ID
name	string	必須	フォルダ名
parent_id	string \| null	任意	親フォルダ ID（ルートの場合 null）
created_by	string \| null	任意	作成者 ID
created_at	string	必須	作成日時 (ISO 8601)
updated_at	string	必須	更新日時 (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

ドキュメントを表すオブジェクトです。更新時には自動的にバージョンが保存されます。

フィールド

名前	型	必須	説明
id	string	必須	ドキュメント ID
object	string	必須	オブジェクト種別（`docs.document`）
organization_id	string	必須	組織 ID
title	string	必須	タイトル
content	string \| null	任意	本文（JSON）
status	"draft" \| "review" \| "published" \| "archived"	必須	ステータス（draft: 下書き、review: レビュー中、published: 公開、archived: アーカイブ）
folder_id	string \| null	任意	フォルダ ID
category	string \| null	任意	カテゴリ
tags	string \| null	任意	タグ（カンマ区切り）
version	integer	必須	現在のバージョン番号
created_by	string \| null	任意	作成者 ID
updated_by	string \| null	任意	最終更新者 ID
created_at	string	必須	作成日時 (ISO 8601)
updated_at	string	必須	更新日時 (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

ドキュメントのバージョンスナップショットを表すオブジェクトです。ドキュメントの更新時に更新前の内容が自動保存されます。

フィールド

名前	型	必須	説明
id	string	必須	バージョン ID
object	string	必須	オブジェクト種別（`docs.version`）
document_id	string	必須	ドキュメント ID
version	integer	必須	バージョン番号
content	string \| null	任意	バージョン時点の本文（JSON）
created_by	string \| null	任意	作成者 ID
created_at	string	必須	作成日時 (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"
}