BlueAI 契約書（Documents）
契約書の作成・更新・送信・キャンセル・リマインドを行います。
|
エンドポイント
| GET | /api/v1/sign/documents | 契約書一覧を取得 |
| POST | /api/v1/sign/documents | 契約書を作成 |
| GET | /api/v1/sign/documents/{id} | 契約書を取得 |
| PATCH | /api/v1/sign/documents/{id} | 契約書を更新 |
| DELETE | /api/v1/sign/documents/{id} | 契約書を削除 |
| POST | /api/v1/sign/documents/{id}/send | 署名依頼を送信 |
| POST | /api/v1/sign/documents/{id}/cancel | 署名依頼をキャンセル |
| POST | /api/v1/sign/documents/{id}/remind | 署名リマインドを送信 |
GET
/api/v1/sign/documents契約書一覧を取得
認証が必要です— セッション Cookie または Bearer トークンを含めてください
クエリパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
status | string | 任意 | ステータスで絞り込み（draft / sent / signed / cancelled） |
limit | integer | 任意 | 取得件数（デフォルト: 50, 最大: 200） |
offset | integer | 任意 | スキップ件数 |
コード例
curl "https://api.blueai.jp/api/v1/sign/documents" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/sign/documents契約書を作成
認証が必要です— セッション Cookie または Bearer トークンを含めてください
コード例
curl -X POST "https://api.blueai.jp/api/v1/sign/documents" \
-H "Cookie: better-auth.session_token=<token>"GET
/api/v1/sign/documents/{id}契約書を取得
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 契約書 ID |
コード例
curl "https://api.blueai.jp/api/v1/sign/documents/doc_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"PATCH
/api/v1/sign/documents/{id}契約書を更新
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 契約書 ID |
コード例
curl -X PATCH "https://api.blueai.jp/api/v1/sign/documents/doc_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"DELETE
/api/v1/sign/documents/{id}契約書を削除
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 契約書 ID |
コード例
curl -X DELETE "https://api.blueai.jp/api/v1/sign/documents/doc_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/sign/documents/{id}/send署名依頼を送信
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 契約書 ID |
コード例
curl -X POST "https://api.blueai.jp/api/v1/sign/documents/doc_123e4567e89b12d3a456426614174000/send" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/sign/documents/{id}/cancel署名依頼をキャンセル
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 契約書 ID |
コード例
curl -X POST "https://api.blueai.jp/api/v1/sign/documents/doc_123e4567e89b12d3a456426614174000/cancel" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/sign/documents/{id}/remind署名リマインドを送信
認証が必要です— セッション Cookie または Bearer トークンを含めてください
パスパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 任意 | 契約書 ID |
コード例
curl -X POST "https://api.blueai.jp/api/v1/sign/documents/doc_123e4567e89b12d3a456426614174000/remind" \
-H "Cookie: better-auth.session_token=<token>"