IDを指定してBox Signテンプレートを取得

cURL

curl -L -X GET "https://api.box.com/2.0/sign_templates/12345678" \
     -H "accept: application/json" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

{
  "type": "sign-template",
  "id": "4206996024-14944f75-c34b-478a-95a1-264b1ff80d35",
  "name": "Official contract",
  "email_subject": "Sign Request from Acme",
  "email_message": "Hello! Please sign the document below",
  "days_valid": 2,
  "parent_folder": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contracts"
  },
  "source_files": [
    {
      "id": "12345",
      "type": "file",
      "etag": "1",
      "sequence_id": "3",
      "name": "Contract.pdf",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
      "file_version": {
        "id": "12345",
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      }
    }
  ],
  "are_fields_locked": false,
  "are_options_locked": true,
  "are_recipients_locked": false,
  "are_email_settings_locked": true,
  "are_files_locked": true,
  "signers": [
    {
      "inputs": [
        {
          "page_index": 4,
          "document_tag_id": "1234",
          "text_value": "text",
          "checkbox_value": true,
          "date_value": "2021-04-26",
          "type": "text",
          "content_type": "text",
          "is_required": true,
          "document_id": "123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7",
          "dropdown_choices": [
            "Yes",
            "No",
            "Maybe"
          ],
          "group_id": "da317330-225a-4c72-89ad-0d6dcaaf4df6",
          "coordinates": {
            "x": 0.672258592471358,
            "y": 0.18654283173599448
          },
          "dimensions": {
            "width": 0.2618657937806874,
            "height": 0.05311728090109673
          },
          "label": "Legal name",
          "read_only": true,
          "validation": {
            "validation_type": "email"
          }
        }
      ],
      "email": "example@mail.com",
      "role": "signer",
      "is_in_person": true,
      "order": 2,
      "signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7",
      "label": "Jane Doe",
      "public_id": "RJZYYVPR",
      "is_password_required": true,
      "is_phone_number_required": true,
      "login_required": true
    }
  ],
  "additional_info": {
    "non_editable": [
      "email_subject",
      "name"
    ],
    "required": {
      "signers": [
        [
          "email"
        ],
        [
          "email"
        ]
      ]
    }
  },
  "ready_sign_link": {
    "url": "\"https://app.box.com/sign/\nready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178\"",
    "name": "Official contract",
    "instructions": "Hello! Please sign the document below",
    "folder_id": "12345",
    "is_notification_disabled": true,
    "is_active": false
  },
  "custom_branding": {
    "company_name": "Corporation inc.",
    "logo_uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA\nAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A\n8AAQUBAScY42YAAAAASUVORK5CYII=",
    "branding_color": "9E5E6F",
    "email_footer_text": "Contact email email@mail.com"
  },
  "request_flow": "standard"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

GET

sign_templates

{template_id}

cURL

curl -L -X GET "https://api.box.com/2.0/sign_templates/12345678" \
     -H "accept: application/json" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

{
  "type": "sign-template",
  "id": "4206996024-14944f75-c34b-478a-95a1-264b1ff80d35",
  "name": "Official contract",
  "email_subject": "Sign Request from Acme",
  "email_message": "Hello! Please sign the document below",
  "days_valid": 2,
  "parent_folder": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contracts"
  },
  "source_files": [
    {
      "id": "12345",
      "type": "file",
      "etag": "1",
      "sequence_id": "3",
      "name": "Contract.pdf",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
      "file_version": {
        "id": "12345",
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      }
    }
  ],
  "are_fields_locked": false,
  "are_options_locked": true,
  "are_recipients_locked": false,
  "are_email_settings_locked": true,
  "are_files_locked": true,
  "signers": [
    {
      "inputs": [
        {
          "page_index": 4,
          "document_tag_id": "1234",
          "text_value": "text",
          "checkbox_value": true,
          "date_value": "2021-04-26",
          "type": "text",
          "content_type": "text",
          "is_required": true,
          "document_id": "123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7",
          "dropdown_choices": [
            "Yes",
            "No",
            "Maybe"
          ],
          "group_id": "da317330-225a-4c72-89ad-0d6dcaaf4df6",
          "coordinates": {
            "x": 0.672258592471358,
            "y": 0.18654283173599448
          },
          "dimensions": {
            "width": 0.2618657937806874,
            "height": 0.05311728090109673
          },
          "label": "Legal name",
          "read_only": true,
          "validation": {
            "validation_type": "email"
          }
        }
      ],
      "email": "example@mail.com",
      "role": "signer",
      "is_in_person": true,
      "order": 2,
      "signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7",
      "label": "Jane Doe",
      "public_id": "RJZYYVPR",
      "is_password_required": true,
      "is_phone_number_required": true,
      "login_required": true
    }
  ],
  "additional_info": {
    "non_editable": [
      "email_subject",
      "name"
    ],
    "required": {
      "signers": [
        [
          "email"
        ],
        [
          "email"
        ]
      ]
    }
  },
  "ready_sign_link": {
    "url": "\"https://app.box.com/sign/\nready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178\"",
    "name": "Official contract",
    "instructions": "Hello! Please sign the document below",
    "folder_id": "12345",
    "is_notification_disabled": true,
    "is_active": false
  },
  "custom_branding": {
    "company_name": "Corporation inc.",
    "logo_uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA\nAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A\n8AAQUBAScY42YAAAAASUVORK5CYII=",
    "branding_color": "9E5E6F",
    "email_footer_text": "Contact email email@mail.com"
  },
  "request_flow": "standard"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

このリソースは、バージョン2024.0のエンドポイントで使用されています。詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

Authorization

string

header

必須

The access token received from the authorization server in the OAuth 2.0 flow.

パスパラメータ

template_id

string

必須

Box SignテンプレートのID。

レスポンス

テンプレートの詳細を返します。

Box Signテンプレートオブジェクト。

type

enum<string>

値は常にsign-templateになります。

利用可能なオプション:

sign-template

例:

"sign-template"

string

テンプレートの識別子。

例:

"4206996024-14944f75-c34b-478a-95a1-264b1ff80d35"

name

string | null

テンプレートの名前。

例:

"Official contract"

email_subject

string | null

署名リクエストメールの件名。これは、署名リクエストによって消去されます。このフィールドを渡さない場合は、デフォルトの件名が使用されます。

例:

"Sign Request from Acme"

email_message

string | null

署名リクエストメールに含めるメッセージ。このフィールドは、特定の文字のサニタイズによって消去されます。ただし、一部のHTMLタグは使用できます。また、このメッセージに含まれているリンクはメールではハイパーリンクに変換されます。このメッセージには、HTMLタグa、abbr、acronym、b、blockquote、code、em、i、ul、li、ol、strongを含めることができます。HTMLに対するテキストの比率が大きすぎると、メールがスパムフィルタに入る可能性があることに注意してください。これらのタグにカスタムスタイルを適用することはできません。このフィールドを渡さない場合は、デフォルトのメッセージが使用されます。

例:

"Hello! Please sign the document below"

days_valid

integer | null

作成した署名リクエストが完了しなかった場合に自動的に期限切れになるまでの日数を設定します。デフォルトでは、署名リクエストに有効期限を適用しないため、署名リクエストは期限切れになりません。

必須範囲: 0 <= x <= 730

例:

2

parent_folder

フォルダ (Mini) · object

最終的な署名済みドキュメントと署名ログの保存先フォルダ。IDフィールドとtypeフィールドのみが必要です。ルートフォルダ (フォルダID 0) は使用できません。

Show child attributes

source_files

(ファイル (Mini) · object | null)[]

署名するドキュメントの作成元ファイルのリスト。ファイルごとにIDフィールドとtypeフィールドのみが必要です。

他のリソースの下にネストされたときに使用されるファイルのMini版の表示。

Show child attributes

are_fields_locked

boolean

テンプレートの入力フィールドが編集可能かどうかを示します。

例:

false

are_options_locked

boolean

テンプレートドキュメントのオプション (ドキュメントの名前変更など) が編集可能かどうかを示します。

例:

true

are_recipients_locked

boolean

テンプレートの署名者が編集可能かどうかを示します。

例:

false

are_email_settings_locked

boolean

テンプレートのメール設定が編集可能かどうかを示します。

例:

true

are_files_locked

boolean

テンプレートファイルが編集可能かどうかを示します。これには、テンプレートファイルの削除または名前変更が含まれます。

例:

true

signers

テンプレートの署名者フィールド · object[]

テンプレートの署名者の配列。

注: テンプレートで指定された一部の署名者が競合するセグメント (ユーザーグループ) に属している可能性もあります。これは、セキュリティポリシーにより、倫理的な競合につながる可能性のあるやり取りやコミュニケーションを防ぐためにユーザーがセグメントに割り当てられていることを意味します。このような場合、競合するセグメントに存在する署名者を含むテンプレートに基づいて署名リクエストを送信しようとすると、エラーが発生します。

セグメントと情報バリアの詳細については、こちらを参照してください。

Show child attributes

additional_info

object

必須フィールドと編集不可フィールドに関する追加情報。

Show child attributes

ready_sign_link

object | null

Boxの署名リンク機能により、テンプレートから作成した署名リクエストへのリンクを作成できます。このリンクは、署名者が誰になるか不明な状態で公開フォーム (メール、ソーシャルメディアの投稿、ウェブページなど) に署名リクエストを投稿する場合に使用します。注: 署名リンク機能は、Enterprise Plusをご利用のお客様に限定されており、Box Verified Enterpriseでは利用できません。

Show child attributes

custom_branding

object | null

通知および署名リクエストに適用されているカスタムブランド設定。

Show child attributes

request_flow

string | null

テンプレートから作成された署名リクエストの署名フロー。値にはstandardまたはcfr11を指定できます。

例:

"standard"

最終更新日 2026年1月23日

APIリファレンス

v2025.0

v2026.0

IDを指定してBox Signテンプレートを取得

承認

パスパラメータ

レスポンス