Skip to content
/
契約書情報を更新

LegalOn API (1.1.0)

API documentation for LegalOn services

Languages
Servers
サーバーのURLは `{api_base_url}/rest/v1` です。 アクセストークン取得時のレスポンスに含まれる `api_base_url` の値を用いてサーバーの URL を構成してください。
https://{api_base_url_without_scheme}/rest/v1

ユーザー

ユーザーに関する操作

Operations

ユーザーグループ

ユーザーグループに関する操作

Operations

ワークスペース

ユーザーの閲覧権限によらず、テナント内のすべてのワークスペース/フォルダに関する操作

Operations

部署

部署に関する操作

Operations

契約書（ファイル）

契約書の作成・取得・更新・削除などの操作を提供します。ワークスペースを対象とする操作では、共通の「ワークスペース」（GET /workspaces）で取得した workspace_id を指定してください。

Operations

契約書バージョン一覧を取得

Request

指定した契約書の全バージョンをバージョン番号の昇順で取得します。

Security
OAuth2ClientCredentials
Path
document_idstring(uuid)required

契約書 ID

curl -i -X GET \
  'https://{api_base_url_without_scheme}/rest/v1/contracts/{document_id}/versions' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

正常に契約書バージョン一覧を取得

Bodyapplication/json
document_idstring(uuid)required

契約書 ID

versionsArray of objects(contract_version_summary)required

契約書バージョン一覧

versions[].​document_version_idstring(uuid)required

契約書バージョンID

versions[].​version_numberinteger>= 1required

現在の契約書バージョン一覧におけるバージョン番号

versions[].​file_namestring[ 1 .. 255 ] charactersrequired

ファイル名

versions[].​created_atstring(date-time)required

契約書バージョンの作成日時

versions[].​updated_atstring(date-time)required

契約書バージョンの更新日時

Response
application/json
{
  "document_id": "00000016-0000-0000-0001-100000000001",
  "versions": [
    { … },
    { … }
  ]
}

契約書情報を更新

Request

指定した契約書バージョンのメタデータを更新します。

Security
OAuth2ClientCredentials
Path
document_idstring(uuid)required

契約書 ID

document_version_idstring(uuid)required

契約書バージョンID

Bodyapplication/jsonrequired

契約書情報更新リクエスト

metadataobject(update_contract_metadata_request)required

契約書メタデータ更新リクエスト。契約書メタデータ更新 source で更新できる項目と document_status_code を受け付ける。document_status_code を未指定にすると現在のステータスを変更しない。NONE を指定すると現在のステータスを削除する。

metadata.​titlestring[ 1 .. 1000 ] characters

契約書タイトル

metadata.​language_codestring[ 2 .. 35 ] characters

契約書の言語コード

metadata.​contract_category_positionsArray of objects(contract_category_position)

契約類型・立場・準拠法の分類

metadata.​own_partiesArray of strings(party)

自社名一覧

metadata.​counter_partiesArray of strings(party)

取引先名一覧

metadata.​document_status_codestring(document_status_code)

締結前契約書の契約書ステータスコード。NONE は契約書ステータスなしを表す。

Enum"COUNTERPARTY_DRAFT""INTERNAL_DRAFT""COUNTERPARTY_REVISION""INTERNAL_REVISION""APPROVED_VERSION""READY_FOR_SIGNATURE""NONE"
curl -i -X PATCH \
  'https://{api_base_url_without_scheme}/rest/v1/contracts/{document_id}/versions/{document_version_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": {
      "title": "Confidentiality Agreement",
      "language_code": "en",
      "own_parties": [
        "LegalOn Technologies, Inc."
      ],
      "counter_parties": [
        "Example Corp."
      ],
      "contract_category_positions": [
        {
          "category_code": "NDA",
          "position_code": "discloser",
          "governing_law_code": "JP"
        }
      ],
      "document_status_code": "INTERNAL_DRAFT"
    }
  }'

Responses

正常に契約書情報を更新

Bodyapplication/json
document_idstring(uuid)required

契約書 ID

document_version_idstring(uuid)required

更新した契約書バージョンID

version_numberinteger>= 1required

現在の契約書バージョン一覧におけるバージョン番号

updated_atstring(date-time)required

契約書最終更新日時

titlestring[ 1 .. 1000 ] characters

契約書タイトル

language_codestring[ 2 .. 35 ] characters

契約書の言語コード

document_status_codestring(document_status_code)

締結前契約書の契約書ステータスコード。NONE は契約書ステータスなしを表す。

Enum"COUNTERPARTY_DRAFT""INTERNAL_DRAFT""COUNTERPARTY_REVISION""INTERNAL_REVISION""APPROVED_VERSION""READY_FOR_SIGNATURE""NONE"
own_partiesArray of strings(party)

自社名一覧

counter_partiesArray of strings(party)

取引先名一覧

contract_category_positionsArray of objects(contract_category_position)

契約類型・立場・準拠法の分類

Response
application/json
{
  "document_id": "00000016-0000-0000-0001-100000000001",
  "document_version_id": "00000016-0000-0000-0001-100000000101",
  "version_number": 3,
  "updated_at": "2026-05-08T03:13:20Z",
  "title": "Confidentiality Agreement",
  "language_code": "en",
  "document_status_code": "INTERNAL_DRAFT",
  "own_parties": [
    "LegalOn Technologies, Inc."
  ],
  "counter_parties": [
    "Example Corp."
  ],
  "contract_category_positions": [
    { … }
  ]
}

契約書バージョンを削除

Request

指定した契約書バージョンを削除します。

Security
OAuth2ClientCredentials
Path
document_idstring(uuid)required

契約書 ID

document_version_idstring(uuid)required

契約書バージョンID

curl -i -X DELETE \
  'https://{api_base_url_without_scheme}/rest/v1/contracts/{document_id}/versions/{document_version_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

正常に契約書バージョンを削除

Response
No content

ワークスペース

共通のワークスペース/フォルダは、契約書などのリソースを格納・整理する単位です。本エンドポイントは、APIを呼び出すユーザーがアクセス権を持つワークスペース/フォルダをツリー構造で返します。契約書APIなどワークスペースを対象とする操作では、ここで取得した workspace_id を指定してください。テナント内全体の管理（作成・権限設定など）は管理者設定のワークスペース操作（/spaces）を参照してください。

Operations