コンテンツにスキップ
commentor API
Esc
↑↓移動↵開く⌘Jプレビュー

文書の一覧を読む

トークンの持ち主が見られる文書の一覧を返す。題名・タグ・未解決のコメントの数で、操作の対象を選ぶのに使う。

GET/api/reviews
Authorization
AuthorizationBearer token · headerrequired

取り込み用トークン。文書を上げる、版を追加する、文書の一覧と中身を読むのに使う。

or
AuthorizationBearer token · headerrequired

本人用の個人トークン。発行時に選んだ範囲の操作を、本人の名義で行う。読み取りと本人のトークン操作は、範囲を問わず使える。

Query parameters
projectstring

案件コード。指定すると、その案件に結び付いた文書だけを返す。大文字・小文字は区別しない。

matches ^[A-Z0-9][A-Z0-9-]{0,31}$
Responses
200

読めた。

reviewsReviewSummary[]
Show properties
Array of ReviewSummary
reviewIdstring
titlestring
accessModestring

link はリンクを知る人が見られる。restricted は招待した人だけ。

Allowed:linkrestricted
rolestring

トークンの持ち主のこの文書での役割。

createdAtstring<date-time>
countsobject
Show properties
openinteger

未解決のコメントの数。

totalinteger
lastActivityTsinteger | null

最後にコメントなどが動いた時刻(UNIX 時間のミリ秒)。動きが無ければ null。

tagsstring[]
archivedTsinteger | null

アーカイブした時刻(UNIX 時間のミリ秒)。アーカイブしていなければ null。

projectstring

この文書に案件の結び付けがあるときだけ付く案件コード。

400

案件コードの形が違うか、存在しない案件を指定した(invalid_project)。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

401

トークンが無いか、この文書を読む権限が無い。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

403

このトークンでは使えない操作か、対象に対する権限が無い。使えるトークンは各操作の Authorization の欄を見る。

errorstringrequired

エラーの種類を表す短いコード。対処を分けるときはこの値を見る。

statusintegerrequired

HTTP ステータスと同じ値。

currentRevisioninteger

409 comments revision conflict のとき、文書の今の commentsRevision。

latestVersionIdstring

409 stale_target_version のとき、文書の最新版の ID。

Request
curl -X GET 'https://comment-review.fsmarketing.workers.dev/api/reviews' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "reviews": [
    {
      "reviewId": "review_example01",
      "title": "料金ページの下書き",
      "accessMode": "restricted",
      "role": "owner",
      "project": "EX-AA",
      "createdAt": "2026-10-01T09:00:00.000Z",
      "counts": {
        "open": 2,
        "total": 5
      },
      "lastActivityTs": 1790845200000,
      "tags": [
        "LP"
      ],
      "archivedTs": null
    }
  ]
}